mirror of
https://github.com/ClementTsang/bottom.git
synced 2025-07-31 01:24:31 +02:00
dab4b6c483
* other: master -> main I'm so used to using `main` branch now that it's actually kinda annoying to use `master` for just this repo... so might as well rename it now. * overzealous change * wording * some wording * allow auto-cancel for tests if not main
36 lines
2.0 KiB
Markdown
36 lines
2.0 KiB
Markdown
# Issues, Pull Requests, and Discussions
|
|
|
|
## Discussions
|
|
|
|
Discussions are open [in the repo](https://github.com/ClementTsang/bottom/discussions). As for the difference between discussions and issues:
|
|
|
|
- Open an issue if what you have enough information to properly fill out any details needed for a report or request.
|
|
- Open a discussion otherwise (e.g. asking a question).
|
|
|
|
## Opening an issue
|
|
|
|
### Bug reports
|
|
|
|
When filing a bug report, please use the [bug report template](https://github.com/ClementTsang/bottom/issues/new?assignees=&labels=bug&template=bug_report.md&title=) 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.
|
|
|
|
Also, please check whether an existing issue has covered your specific feature request!
|
|
|
|
## Pull requests
|
|
|
|
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. See [here](./documentation.md) for tips on documentation.
|
|
4. Commit and create a pull request to merge into the `main` 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 to maintain repo cleanliness, though
|
|
feel free to ask otherwise if that isn't preferable.
|