Contributing

Thanks for getting involved! Here is some information we’d like you to read and understand before you make your mark as a valued contributor.

Licensing

Whenever you make a contribution to a repository containing notice of a license, you license your contribution under the same terms, and you agree that you have the right to license your contribution under those terms. If you have a separate agreement to license your contributions under different terms, such as a contributor license agreement, that agreement will supersede.

By participating in this project you agree to abide by the terms of our Contributor Code of Conduct.

Submitting a pull request

  1. Fork and clone the repository
  2. Configure and install any required dependencies for the project
  3. Make sure any tests included in the project pass on your local machine
  4. Create a new branch: git checkout -b my-branch-name
  5. Make your change, add tests (where applicable), and make sure all included tests still pass
  6. Push to your fork and submit a pull request, filling in as much of the template as you can plus any other useful information that will aid in a great review
  7. Check back in now and then to see if there are any comment or questions about your pull request, and we’ll get is reviewed and merged as soon as we can!

A few reminders when submitting a pull request:

  • Follow standards for style and code quality
  • Write tests.
  • Keep your change as focused as possible. If there are multiple changes you would like to make that are not dependent upon each other, consider submitting them as separate pull requests.
  • Write a good commit message.

Branch schema

Branch Description
main The most recent version on CRAN, if you’re submitting a fix to an issue with the CRAN release, fork this branch
dev The branch with all the approved changes for the next release. Submit your PRs to this branch. When a new version is released on CRAN this branch gets merged with main.

What can you help with?

If you’d like to contribute, but aren’t sure where to start, take a look at the open issues in this repository for some ideas.

Reporting a security vulnerability or feedback

If you discover a potential security issue in this project we ask that you notify Peak AI Security directly via email to . Please do not create a public github issue.