tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity
bottom/CONTRIBUTING.md

2.4 KiB
Raw Blame History

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:

  1. Fork the project.
  2. Make your changes.
  3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See here for tips on documentation.
  4. Commit and create a pull request to merge into the master branch. Please fill out the pull request template.
  5. Ask a maintainer to review your pull request.
    • Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first-time contributor, you may need to wait for a maintainer to let CI run.
    • If changes are suggested or any comments are made, they should probably be addressed.
  6. Once it looks good, it'll be merged! Note that generally, PRs are squashed to maintain repo cleanliness, 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, see here for details on how to build bottom, corresponding completion/manpages, and how to add installation instructions for the package to the README.