tyler.durden
/
bottom
mirror of https://github.com/ClementTsang/bottom.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

docs: tweak wording in README and CONTRIBUTING

This commit is contained in:
ClementTsang 2021-10-17 21:44:19 -04:00
parent ea0c7b49b7
commit a9b808334c
2 changed files with 11 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
CONTRIBUTING.md
View File

@ -15,14 +15,15 @@ Please use the [feature request template](https://github.com/ClementTsang/bottom
## Pull requests
The expected workflow for a pull request is:
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](./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!
2. Make your changes locally.
- If you're making a documentation change, you may want to read [this page](https://clementtsang.github.io/bottom/nightly/contribution/documentation/), especially if you're touching mkdocs pages.
- If you add a new feature, it'll probably also need documentation changes - again, see [this page](https://clementtsang.github.io/bottom/nightly/contribution/documentation/).
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!
## Further reading

7
README.md
View File

@ -244,12 +244,13 @@ More details on configuration can be found [in the documentation](https://clemen
## Contribution
Whether it's reporting problems, documentation, or code, contribution is always welcome! Please read
[CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to contribute to bottom.
Whether it's reporting bugs, suggesting features, maintaining packages, or submitting a PR,
contribution is always welcome! Please read [CONTRIBUTING.md](./CONTRIBUTING.md) for details on how to
contribute to bottom.
### Contributors
Thanks to all contributors ([emoji key](https://allcontributors.org/docs/en/emoji-key)):
Thanks to all contributors:
<!-- ALL-CONTRIBUTORS-LIST:START - Do not remove or modify this section -->
<!-- prettier-ignore-start -->