Hello, and thank you for taking the time to read the contributing guidelines for Sandhole! Please read through our Code of Conduct as well.
Here are some ways to contribute to the project:
Please search the existing issues, as well as the Sandhole book, for any answers or existing discussions before creating your own issue.
In the case that you'd like to make contributions to Sandhole, create an issue first if one does not exist.
If you wish to contribute changes to Sandhole, please fork the repository, push your modifications to a branch other than main, and create a pull request. Make sure to link to the original issue in your PR's body.
If possible, make sure that your changes pass all tests and linting/formatting checks before creating a pull request by running just test and just clippy, respectively. This should ensure that your PR will pass the CI pipeline.
Please add a short description of any user-facing changes to the top of CHANGELOG.md, under the "Unreleased" section (or create one if it does not exist). The changelog must adhere to Keep a Changelog, and it must emphasize any breaking changes.
If you're adding or modifying a command line option, run just cli to update the book. This requires you to have nix installed.