Skip to content

Latest commit

 

History

History
43 lines (24 loc) · 1.21 KB

CONTRIBUTING.md

File metadata and controls

43 lines (24 loc) · 1.21 KB

CONTRIBUTING: Notes on forks and pull requests

We are thrilled that you would like to collaborate on this project. Your help is essential.

Submitting a pull request

  1. Fork and clone the repository.
  2. Create a new branch: git checkout -b my-branch-name
  3. Make your change, add tests, and make sure the tests still pass.
  4. Push to your fork and submit a pull request
  5. Wait for your pull request to be reviewed.

Testing

See tests directory for details.

Tips regarding pull requests

  • Refine the tests whenever possible.

  • Update documentation as necessary.

  • Keep your change focused. If there are multiple changes that are not dependent upon each other, please submit them as separate pull requests.

  • Write a good commit message.

Thanks very much for your consideration. Looking forward to reviewing your code.

Resources