diff options
author | ClementTsang <34804052+ClementTsang@users.noreply.github.com> | 2023-02-13 03:35:46 -0500 |
---|---|---|
committer | ClementTsang <34804052+ClementTsang@users.noreply.github.com> | 2023-02-13 03:35:46 -0500 |
commit | a266dd74eccfc5ce3431ef0087bd8f308bdb654a (patch) | |
tree | fb4da95e0e35ea9d6ad70dacf5e68092ca2adefe /CONTRIBUTING.md | |
parent | c19f429d35bd5ea2824a584762191d010bddfb6d (diff) |
docs: update contributing docs/links
Diffstat (limited to 'CONTRIBUTING.md')
-rw-r--r-- | CONTRIBUTING.md | 20 |
1 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4b5c367f..d37c3c97 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,13 +6,13 @@ 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.yml&title=%5BBug%5D%3A+) +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+) 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. +Please use the [feature request template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=feature&template=feature_request.yml&title=%5BFeature%5D+) 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 @@ -21,12 +21,14 @@ If you want to directly contribute documentation changes or code, follow this! T 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. +3. Make any documentation changes if necessary - if you add a new feature, it'll probably need documentation changes. See [here](https://clementtsang.github.io/bottom/nightly/contribution/documentation/) for tips on documentation. +4. Commit and create a pull request to merge into the `master` branch. **Please fill out the pull request template**. +5. Ask a maintainer to review your pull request. + - Check if the CI workflow passes. These consist of clippy lints, rustfmt checks, and basic tests. If you are a + first-time contributor, you may need to wait for a maintainer to let CI run. - 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. +6. Once it looks good, it'll be merged! Note that _generally_, PRs are squashed to maintain repo cleanliness, 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/). @@ -36,5 +38,5 @@ 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, completion/manpages, and adding installation instructions for the package to the README. +If you want to become a package maintainer, see [here](https://clementtsang.github.io/bottom/nightly/contribution/packaging-and-distribution/) +for details on how to build bottom, corresponding completion/manpages, and how to add installation instructions for the package to the README. |