2020-04-29 05:54:50 +03:00
# Contribution
2021-06-21 08:40:58 +03:00
Contribution in any way is appreciated, whether it is reporting problems, fixing bugs, implementing features, improving the documentation, etc.
2020-04-29 05:54:50 +03:00
2021-06-21 08:40:58 +03:00
## Opening an issue
2020-04-29 05:54:50 +03:00
2021-06-21 08:40:58 +03:00
### Bug reports
2020-04-29 05:54:50 +03:00
2022-09-16 12:16:58 +03:00
When filing a bug report, use the [bug report template ](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.yml&title=%5BBug%5D%3A+ )
2021-11-27 14:42:55 +03:00
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!
2020-04-29 05:54:50 +03:00
2021-06-21 08:40:58 +03:00
### Feature requests
2020-04-29 05:54:50 +03:00
2022-09-16 12:16:58 +03:00
Please use the [feature request template ](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.md&title= ) and fill it out.
Remember to give details about what the feature is along with why you think this suggestion will be useful.
2020-04-29 05:54:50 +03:00
## Pull requests
2021-10-18 04:44:19 +03:00
If you want to directly contribute documentation changes or code, follow this! The expected workflow for a pull request is:
2020-04-29 05:54:50 +03:00
2021-06-21 08:40:58 +03:00
1. Fork the project.
2022-09-16 12:16:58 +03:00
2. Make your changes.
3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes.
4. Commit and create a pull request to merge into the `master` branch. **Please follow the pull request template** .
5. Ask/wait for a maintainer to review your pull request.
2022-11-12 07:45:27 +03:00
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests.
2022-09-16 12:16:58 +03:00
- 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, though feel free to ask otherwise if that isn't preferable.
2020-04-29 05:54:50 +03:00
2021-12-19 23:42:22 +03:00
For more details, see [here ](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/ ).
2020-04-29 05:54:50 +03:00
2021-10-20 01:29:59 +03:00
### Documentation
2021-12-19 23:42:22 +03:00
For contributing to documentation, see [here ](https://clementtsang.github.io/bottom/nightly/contribution/documentation/ ).
2021-10-20 01:29:59 +03:00
### Packaging
2021-12-19 23:42:22 +03:00
If you want to become a package maintainer, look [here ](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/ )
2022-09-16 12:16:58 +03:00
for instructions on how to build bottom, completion/manpages, and adding installation instructions for the package to the README.