Skip to content

Latest commit

 

History

History
45 lines (29 loc) · 2.81 KB

CONTRIBUTING.md

File metadata and controls

45 lines (29 loc) · 2.81 KB
Raw

Contributing

We love pull requests from everyone. 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, 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

Making changes

  • Before you make a Pull Request, make sure you have discussed your proposed change in an issue post and that the team support your proposed change.
  • We recommend that you create a Git branch for each pull request (PR).
  • Look at the Travis build status before and after making changes. The README should contain badges for any continuous integration services used by the package.
  • 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.
  • We use testthat. Contributions with test cases included are easier to accept.
  • For user-facing changes, add a bullet to the top of NEWS.md below the current development version header describing the changes made followed by your GitHub username, and links to relevant issue(s)/PR(s).
  • 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.

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.

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