Warrant is under active development and welcomes contributions from the community via pull requests.
Prior to submitting any PRs, please review and familiarize yourself with the following guidelines and our Code of Conduct.
- All outstanding bugs and feature requests are tracked as GitHub issues.
- If you find a bug or have a feature request, please open an issue. In order to prevent duplicate reports, please first search through existing open issues for your request prior to creating a new one.
- If you discover a security issue or vulnerability, do not create an issue. Please email us with details at [email protected].
- If you find small mistakes or issues in docs/instructions etc., feel free to submit PR fixes without first creating issues.
- If you'd like to contribute a fix or implementation for an issue, please first consult on your approach with a member of the Warrant team directly on the GitHub issue.
- Here is a list of 'good first issues' for new contributors.
- Refer to the local development guide to get your development environment set up.
- Warrant uses the fork & pull request flow. Please make sure to fork your own copy of the repo and use feature branches for development.
- Make sure to test your changes and add tests where necessary.
- Unless it's a minor change, never submit a PR without an associated issue.
- Once you've implemented and tested your code changes, submit a pull request.
- Pull requests will trigger ci jobs that run linters, static analysis and tests. It is the submitter's responsibility to ensure that all ci checks are passing.
- A member of the Warrant team will review your PR. Once approved, you may merge your PR into main.
- New versions will be tagged and released automatically.