Skip to content
New issue

Have a question about this project? # for a free GitHub account to open an issue and contact its maintainers and the community.

#

By clicking “#”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? # to your account

Jump to bottom

Put GitHub md files in .github/ #165

Closed
jennybc opened this issue Dec 28, 2017 · 8 comments
Closed

Put GitHub md files in .github/ #165

jennybc opened this issue Dec 28, 2017 · 8 comments
Labels
feature a feature request or enhancement

Comments

@jennybc
Copy link
Member

jennybc commented Dec 28, 2017

Should we?

https://github.com/blog/2111-issue-and-pull-request-templates

https://help.github.com/articles/setting-guidelines-for-repository-contributors/

https://help.github.com/articles/creating-an-issue-template-for-your-repository/
@hadley hadley changed the title Put issue_template.md and CONTRIBUTING.md below .github/ Put GitHub md files .github/ Dec 28, 2017
@hadley
Copy link
Member

hadley commented Dec 28, 2017

I think so - at least for use_tidy_xyz.

  • ISSUE_TEMPLATE.md
  • CONTRIBUTING.md
  • CODE_OF_CONDUCT.md
  • SUPPORT.md

Only downside is that we can't link directly from README because that will break when release to CRAN (although, come to think of it, they're all .Rbuildignored already, so they won't work anyway).

@batpigandme
Copy link
Contributor

Should we have use_.github (except a function name that's not that) as an option, or just change the paths for the above-mentioned docs?

@hadley
Copy link
Member

hadley commented Dec 29, 2017

I think we can just change the paths - we are only creating these for tidyverse packages so we can pick a convention that we like. Will need to add .github to .Rbuildignore instead of the individual files.

We might also consider having use_tidy_community() to create all of them? (And maybe even get rid of the individual functions?)

@jennybc
Copy link
Member Author

jennybc commented Dec 29, 2017

I plan to deal with this before long (the putting of things below .github/).

@jennybc jennybc mentioned this issue Jan 15, 2018
Closed
@jennybc jennybc changed the title Put GitHub md files .github/ Put GitHub md files in .github/ Jan 16, 2018
@jennybc jennybc added the feature a feature request or enhancement label Jan 16, 2018
@hadley
Copy link
Member

hadley commented Jan 17, 2018

Or maybe just use_tidy_github()

@hadley
Copy link
Member

hadley commented Jan 17, 2018

@jennybc please correct me if I'm wrong, but this is not scheduled this release, right? So maybe @batpigandme can work on it for the next release?

@jennybc
Copy link
Member Author

jennybc commented Jan 17, 2018

Correct, not a goal for this release.

@batpigandme
Copy link
Contributor

✅ it's on my list (you just can't see it here, I assume bc it's out-o'-verse.

@batpigandme batpigandme mentioned this issue Feb 12, 2018
Merged
jennybc pushed a commit that referenced this issue Feb 13, 2018
@batpigandme @jennybc
Puts contributing, issue template, support, and CoC in subdir (#243)
a6ed595 
* Puts contributing, issue templates, support, and code of conduct in subdir
* Fixes #165
* Moves ignore parameter to .github rather than individual files
* Tests for presence of .github directory in tests
* Adds use_tidy_coc() for code of conduct in .github directory (basically an alias for use_code_of_conduct())
* Updates documentation for same
* Add bullet to NEWS

* Adds use_tidy_community() wrapper function for .github dir items

* Edits per JB comments:
* Corrects code formatting in roxygen comments
* Updates correct relative path for CoC
* Checks for github in use_tidy_contributing()

* Actual backticks and parentheses...
# for free to join this conversation on GitHub. Already have an account? # to comment
Assignees
No one assigned
Labels
feature a feature request or enhancement
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
3 participants
@hadley @jennybc @batpigandme