Mirrors/bottom
2
0
Fork 0
mirror of https://github.com/ClementTsang/bottom synced 2024-11-14 00:17:07 +00:00
Code Issues Projects Releases Packages Wiki Activity
bottom/CONTRIBUTING.md
Clement Tsang aa7db6d7e2
docs: change wording slightly for bug report contribution (#613) 
Small wording updates for what is expected from bug reports.
2021-11-27 06:42:55 -05:00

2 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 locally.
  3. Commit and create a pull request to merge into the master branch. Please follow the pull request template.
  4. Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, skip to the next step for now, as GitHub Actions requires approval to run.
  5. Ask a maintainer to review your pull request. If changes are suggested or any comments are made, they should probably be addressed. Once it looks good, it'll be merged!

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 and add installation instructions to the README.