Skip to content

Latest commit

 

History

History
25 lines (16 loc) · 1.22 KB

CONTRIBUTING.md

File metadata and controls

25 lines (16 loc) · 1.22 KB

How to contribute

We really appreciate when users fix bugs or provide new features. When submitting changes, please read below to help the development team keep on top of issues and changes.

Submitting a bug

If you notice something strange, please submit an issue on GitHub. In the issue, please try to achieve the following:

  • Describe what you did
  • Describe what happened when you did it
  • Describe what you think should happen
  • If possible, describe where you think the error is occuring

If you have multiple issues, please submit multiple requests. Once you submit your report, we'll often engage in a conversation or give it a label to be fixed.

Making Changes

When you want to make a change, either to fix a bug or introduce a new feature, please follow the instructions below

  • Create a branch or fork of the project based off of the dev branch.
  • Make commits of logical units
  • Add unit tests for any new features
  • Run all tests in tests/testthat/
  • Create a pull request with a robust description or reference the issue number