Contribution

Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.

Opening an issue

Bug reports

When filing a bug report, use the bug report template and fill in as much as you can. It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, and giving as much detail as possible generally helps to make it easier to reproduce the problem!

Feature requests

Please use the feature request template and fill it out. Remember to give details about what the feature is along with why you think this suggestion will be useful.

Pull requests

If you want to directly contribute documentation changes or code, follow this! The expected workflow for a pull request is:

Fork the project.
Make your changes.
Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes.
Commit and create a pull request to merge into the master branch. Please follow the pull request template.
Ask/wait for a maintainer to review your pull request.
- Check if tests pass. These consist of clippy lints, rustfmt checks, and basic tests.
- If changes are suggested or any comments are made, they should probably be addressed.
Once it looks good, it'll be merged! Note that generally, PRs are squashed, though feel free to ask otherwise if that isn't preferable.

For more details, see here.

Documentation

For contributing to documentation, see here.

Packaging

If you want to become a package maintainer, look here for instructions on how to build bottom, completion/manpages, and adding installation instructions for the package to the README.

2.2 KiB Raw Blame History