Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
21 lines (14 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

21 lines (14 loc) · 1.27 KB

Contributing

Contributions to this project are released to the public under the project's open source license.

We love pull requests. Here's a quick guide

  1. Check for existing issues for duplicates and confirm that it hasn't been fixed already in the main branch
  2. Fork the repo, and clone it locally.
  3. Create a new branch for your contribution
  4. Push to your fork and submit a pull request

Some things that will increase the chance that your pull request is accepted

  • Update the documentation: code comments, example code, guides. Basically, update everything affected by your contribution.
  • Include any information that would be relevant to reproducing bugs, use cases for new features, etc.

Pull Request Reviews & releasing

  • If you plan on implementing a new feature, make sure you create a new branch formatted as feature/feature-name.
  • If you plan on fixing a bug, make sure you create a new branch formatted as fix/bug-name.
  • If you plan on enhancing the codebase, make sure you create a new branch formatted as enhance/feature-name.