Skip to content

Latest commit

 

History

History
52 lines (30 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

52 lines (30 loc) · 1.86 KB

Contributing

All contributions are welcome! If you find a bug or have a feature request, please open an issue or submit a pull request.

Please note that we have a Code of Conduct, please follow it in all your interactions with the project.

How to Contribute

You can make a contribution by following these steps:

  1. Fork this repository, and develop your changes on that fork.
  2. Commit your changes
  3. Submit a pull request from your fork to this project.

Before you start, read through the requirements below.

Commits

Please make your commit messages meaningful. We recommend creating commit messages according to Conventional Commits.

Commit Signature Verification

Each commit's signature must be verified.

Pull Requests

All contributions, including those made by project members, need to be reviewed. We use GitHub pull requests for this purpose. See GitHub Help for more information on how to use pull requests. See the requirements above for PR on this project.

Major new features

If a major new feature is added, there should be new tests for it. If there are no tests, the PR will not be merged.

Versioning

Versions follow Semantic Versioning terminology and are expressed as x.y.z:

  • where x is the major version
  • y is the minor version
  • and z is the patch version

Code convention

Pre-Commit

Please install pre-commit to enforce some pre-commit checks. After cloning the repository, you will need to install the hook script manually:

pre-commit install