Hi there! We're thrilled that you'd like to contribute to Venat.
We want to make contributing to this project 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
- Becoming a maintainer
Contributions to this project are released to the public under the AGPL-3.0 license.
We follow the Conventional Commits guidelines for writing commits.
You can use cz
or yarn commit
to create a commit with the helper tool, or write your commit message manually.
- Fork the repo and create your branch from
main
. - If you've added code that should be tested, add tests.
- Ensure the test suite passes.
- Make sure your code lints.
- Issue a pull request back to
main
.