Skip to content

Latest commit

 

History

History
80 lines (52 loc) · 2.46 KB

CONTRIBUTING.md

File metadata and controls

80 lines (52 loc) · 2.46 KB
Raw

Contribution guidelines

Contributing to this project should be as easy and transparent as possible, whether it's:

  • Reporting a bug
  • Discussing the current state of the code
  • Submitting a fix
  • Proposing new features

Github is used for everything

Github is used to host code, to track issues and feature requests, as well as accept pull requests.

Pull requests are the best way to propose changes to the codebase.

  1. Fork the repo and create your branch from master.
  2. If you've changed something, update the documentation.
  3. Make sure your code lints (using black).
  4. Test you contribution.
  5. 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 issues

GitHub issues are used 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:

  • A quick summary and/or background
  • Steps to reproduce
    • Be specific!
    • Give sample code if you can.
  • What you expected would happen
  • What actually happens
  • Notes (possibly including why you think this might be happening, or stuff you tried that didn't work)

People love thorough bug reports. I'm not even kidding.

Use a Consistent Coding Style

Use black and prettier to make sure the code follows the style.

Or use the pre-commit settings implemented in this repository (see deicated section below).

Test your code modification

You can use the pre-commit settings implemented in this repository to have linting tool checking your contributions (see dedicated section below).

Pre-commit

You can use the pre-commit settings included in the repository to have code style and linting checks.

With pre-commit tool already installed, activate the settings of the repository:

$ pre-commit install

Now the pre-commit tests will be done every time you commit.

You can run the tests on all repository file with the command:

$ pre-commit run --all-files

License

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