mirror of
https://github.com/ClementTsang/bottom
synced 2024-11-21 19:53:05 +00:00
docs: update some contribution documentation
This commit is contained in:
parent
de78824470
commit
10efe75fbd
2 changed files with 15 additions and 9 deletions
|
@ -6,23 +6,27 @@ Contribution in any way is appreciated, whether it is reporting problems, fixing
|
|||
|
||||
### 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.md&title=)
|
||||
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.
|
||||
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 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!
|
||||
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 tests pass. 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/).
|
||||
|
||||
|
@ -33,4 +37,4 @@ For contributing to documentation, see [here](https://clementtsang.github.io/bot
|
|||
### 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 and add installation instructions to the README.
|
||||
for instructions on how to build bottom, completion/manpages, and adding installation instructions for the package to the README.
|
||||
|
|
|
@ -27,5 +27,7 @@ The expected workflow for a pull request is:
|
|||
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](./documentation.md) for tips on documentation.
|
||||
4. Commit and create a pull request to merge into the `master` branch. **Please follow the pull request template**.
|
||||
5. 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.**
|
||||
6. 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!
|
||||
5. Ask/wait for a maintainer to review your pull request.
|
||||
- Check if tests pass. 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.
|
||||
|
|
Loading…
Reference in a new issue