ClementTsang/bottom
1
1
Fork 0
mirror of https://github.com/ClementTsang/bottom.git synced 2024-11-09 04:44:55 +03:00
Code Issues Projects Releases Wiki Activity
c6a3393419
bottom/CONTRIBUTING.md
Clement Tsang dab4b6c483
other: master -> main (#1349) 
* 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
2023-12-06 00:16:26 -05:00

2.4 KiB
Raw Blame History

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, fill out the bug report template. Be sure to give all the neccessary details! It is incredibly difficult for a maintainer to fix a bug when it cannot be reproduced, so that makes it much easier to reproduce the problem!

Feature requests

Please fill out the feature request template. 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. See here 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.

For more details, see here.

Documentation

For contributing to documentation, see here.

Packaging

If you want to become a package maintainer, see here for details on how to build bottom, how to generate/obtain completion files and manpages, and how to add installation instructions for the package to the README.