CONTRIBUTING.md
In coruubc/Rcoru: What the Package Does (One Line, Title Case)

Contributing

We love pull requests from everyone in the lab. By participating in this project, you agree to abide by our code of conduct and you are supporting your lab mates!

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, 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. Or use this line in your shell terminal:

git clone git@github.com:your-username/rrtools.git

Edit the files, save often, and make commits of logical units, where each commit indicates one concept
Follow our style guide.
Make sure you write good commit messages.
Make sure you have added the necessary tests for your code changes.
Run all the tests using devtools::check() to assure nothing else was accidentally broken.
If you need help or unsure about anything, post an update to your issue.

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.

Some things you can do that will increase the chance that your pull request is accepted:

Engage in discussion on your issue.
Be familiar with the background literature cited in the README
Write tests that pass devtools::check().
Follow our code style guide.
Write a good commit message.

There are multiple waws to create and document functions. We like the tutorials provided by Fong Chun Chan's Blog and Rpackages. Regardless of what method you follow, each function you create should have at least the following documentation: