mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-23 12:43:09 +00:00
f41e7cd66d
* ci: unify cache keys in actions * some docs * because empty strings are false in JS * update comment * fix build cache naming
40 lines
2.2 KiB
Markdown
40 lines
2.2 KiB
Markdown
# 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](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.yml&title=%5BBug%5D%3A+)
|
|
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](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.
|
|
|
|
## 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.
|
|
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.
|
|
- Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests.
|
|
- 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.
|
|
|
|
For more details, see [here](https://clementtsang.github.io/bottom/nightly/contribution/issues-and-pull-requests/).
|
|
|
|
### Documentation
|
|
|
|
For contributing to documentation, see [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/).
|
|
|
|
### Packaging
|
|
|
|
If you want to become a package maintainer, look [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/)
|
|
for instructions on how to build bottom, completion/manpages, and adding installation instructions for the package to the README.
|