mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-15 00:47:12 +00:00
06071d5abf
A large migration of documentation over to mkdocs, and some rewrites. Some stuff (install information, basic supported systems, contributors, thanks) are still staying in README.md, and CONTRIBUTING.md is essentially duplicated right now. However, stuff like configuration and key/mouse bindings are now moved to mkdocs. Some parts are still a bit WIP - it is definitely not done (documentation never seems to be...). However, it should be "good enough" for now, and I'm much happier working with the documentation in this form than trying to scroll through a giant endless README.md file. It also works much better for adding new documentation.
1.9 KiB
1.9 KiB
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, please 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
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. See here for tips on documentation.
- Commit and create a pull request to merge into the
masterbranch. Please follow the pull request template. - Wait for the tests to pass. These consist of clippy lints, rustfmt checks, and basic tests. If you are a first time contributor, you may need to skip this step for now, as GitHub Actions requires approval to run.
- 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!