Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
35 lines (21 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

35 lines (21 loc) · 1.29 KB

Contributing to Comps

We love your input! We want to make contributing to the Comps as easy and transparent as possible, whether it's:

We Develop with Github

We use GitHub to host code, to track issues and feature requests, as well as accept pull requests.

Pull Requests

  1. Fork the repo and create your branch from main.
  2. If you've added code that should be tested, add tests.
  3. If you've changed APIs, update the documentation.
  4. Ensure the test suite passes.
  5. Make sure your code lints.
  6. Issue that pull request!

Any contributions you make will be under the MIT Software License

In short, when you submit code changes, your submissions are understood to be under the same MIT License that covers the project. Feel free to contact the maintainers if that's a concern.

Report bugs using Github's issue tracker

We use GitHub issues to track public bugs. Report a bug by opening a new issue; it's that easy!

Write bug reports with detail, background, and sample code

Great Bug Reports tend to have:

  • Be specific!
  • Give sample code if you can.

License

By contributing, you agree that your contributions will be licensed under its MIT License.