Skip to contents

Contributing

Source: CONTRIBUTING.md

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.
    • Forking is not currently enabled

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).
  • Edit the files, save often, and make commits of logical units, where each commit indicates one concept

Style

Commit Messages

Follow standard git commit message advice. In brief:

The first line is the subject, and should summarise the changes in the commit in under 50 characters.

If additional details are required, add a blank line, and then provide explanation and context in paragraph format.

If the commit fixes a GitHub issue include Fixes #. This will ensure that the issue is automatically closed when the commit is merged into master.

Testing

  • We use testthat. Contributions with test cases included are easier to accept.
  • 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

The title of a pull request should briefly describe the changes made. The title should be standalone and should not include the related issue number (i.e. don’t write Fixes #10).

For very simple changes, you can leave the description blank as there’s no need to describe what will be obvious from looking at the diff. For more complex changes, you should give an overview of the changes. If the PR fixes an issue, make sure to include Fixes # in the description.

Push to your fork and submit a pull request.

At this point you’re waiting on us. 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:

Test Note