July 3 2017
Are you ready to contribute to R?
Contribution to R packages hosted on github
Github eases collaboration
- github isn’t just for R packages
- some packages aren’t hosted on github
- there are other ways to contribute that aren’t contributing to package code
Where should you start?
- Visit a package on github
- Open an issue
- Make a contribution via a pull request
- (+) Host your own package on github and make it easy for people to contribute.
1. Visit a package on github
Keep your eyes open for links to github in talks
Visit repo and look around.
1. Look at the code
R code is in the
R directory (might also be in
2. Open an issue
Use an issue to: file a bug report, suggest a feature or ask about how best to contribute.
- Join github!
- For bugs, make sure you include a reproducible example (see reprex package)
- Recognise the maintainer is just a person: be nice!
- Be patient…
3. Making a contribution via a pull request
Try starting with documentation (like I did).
- Low stakes
- May be able to do entirely in browser on github: Editing files in another user’s repository
- Look out for docs generated by other files:
- from roxygen2, edit in
.Rd, and re-generate
README.md may be generated by
3. More complicated pull requests
You need to master a few things:
3. Finding things to contribute to
- Work on issues important to you
- Try searching github:
is:issue is:open label:beginner language:R
- contributr: A Shiny app for finding beginner GitHub issues to contribute to
4+ Host your own package on github and make it easy for people to contribute