We welcome any contributions to this project, be it changes in documentation, bug fixes, new functionality, or even new packages if they fit the scope of our project. By participating in this project, you agree to abide by our code of conduct.
Getting Started
- Make sure you have a GitHub account. If you are not familar with git and GitHub, take a look at http://happygitwithr.com/ to get started.
- Submit a post for your issue for your problem or suggestion, assuming one does not already exist.
- Clearly describe your issue, including steps to reproduce when it is a bug, or some justification for a proposed improvement.
- Fork the repository on GitHub to make a copy of the repository on your account.
Making changes
- Edit the files, save often, and make commits of logical units, where each commit indicates one concept.
- Follow the tidyverse style guide.
- Make sure you write good commit messages.
- Add a unit test for added functionality or a bug you fixed.
- Run all the tests using
rcmdcheck::rcmdcheck()to assure nothing else was accidentally broken. - Edit the NEWS.md file to describe the changes you made.
- If you need help or unsure about anything, post an update to your issue.
Submitting your changes
Push to your fork and submit a pull request.
At this point you’re waiting on us. We like to at least comment on pull requests within a few days (and, typically, one business day). We may suggest some changes or improvements or alternatives.
Tips
Some things you can do that will increase the chance that your pull request is dealt with in a timely manner:
- Engage in discussion on your issue.
- Be familiar with the background literature cited in the README.
- Follow our code style guide.
- Write a good commit message.
- Document your changes in the NEWS.md file.
- Write unit tests for the changes you made.