Maëlle Salmon 🏠 https://masalmon.eu 🐦 ma_salmon
Licence CC-BY-SA
You & other package authors, users, contributors.
People who create visualizations with ggplot2 are the most important members of the community; without these users, this project would have no purpose.
Everyone who contributed to drake is part of targets. Four years of pull requests, issues, rOpenSci discussions, RStudio Community posts, Stack Overflow threads are materializing in this new suite of tools.
Will Landau in https://ropensci.org/blog/2021/02/03/targets/ 🐝
Everyone wants a better, well-maintained package.
Everyone wants something different for themselves.
Kindness 💐
Gracefulness 🩰
Emojis ✨
I think if you want this, you could just include it in a vignette. Unfortunately, I don’t think it’s a good fit for this package: developing good software requires relentless focus, which means that we have to say no to many good ideas. Even though I’m closing this issue, I really appreciate the feedback, and hope you’ll continue to contribute in the future 😄
Hadley Wickham answering a pkgdown issue.
.github/CODE_OF_CONDUCT.md
. Example from (non-rOpenSci) opendatatoronto. usethis::use_code_of_conduct()
.
rOpenSci had a whole community call on the topic!
How do I Create a Code of Conduct for my Event/Lab/Codebase?, With C. Titus Brown, Pauline Barmby, Safia Abdalla.
inst/CITATION
.
Start with usethis::use_citation()
;
Amend it to suit your needs. Example from nasapower.
.github/CONTRIBUTING.md
. Example from wateRinfo.
Style preferences? Infrastructure like roxygen2?
Process preferences? Issue before a PR?
Scope? E.g. in skimr.
Sandbox account creation? Mocking in tests? Use links to external docs.
“BTW, I’ll make some cosmetic changes before I merge this PR, and you don’t need to worry about my style preferences.”
Yihui Xie commenting on a PR of mine to blogdown.
With a special role for GitHub: SECURITY.md, SUPPORT.md.
With no special role for GitHub: GOVERNANCE.md.
In a <account or organization>/.github
repo:
They can be overridden.
How would they find information about contributing?
Not only good for setting up your repo for more contributions. 😁
Development repository URL, pkgdown website URL.
usethis::use_package_doc()
.url
field.“Personally, I take a “belt-and-suspenders” approach and still put citation things in the README.”
Noam Ross, rOpenSci forum.
Explicit sections about help, contributing, citing.
Badges? As a complement to text? (e.g. cpp11 README)
Example 1: See links to the code of conduct & contributing guide.
Example 2 (source): GitHub issues templates / configuration. Don’t add too many choices.
You can even save replies for your account!
And the whole time, be kind! 🕊️