diff options
| author | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-10-17 21:44:19 -0400 |
|---|---|---|
| committer | ClementTsang <cjhtsang@uwaterloo.ca> | 2021-10-17 21:51:30 -0400 |
| commit | a9b808334c9f42c0f9f2d2548d7ec6c6de9a0c5a (patch) | |
| tree | 3bc91d89045adca3bac1bff141de7e230e3647e1 | |
| parent | ea0c7b49b7f4f546f4c20997b6efeea253c8d078 (diff) | |
docs: tweak wording in README and CONTRIBUTING
| -rw-r--r-- | CONTRIBUTING.md | 13 | ||||
| -rw-r--r-- | README.md | 7 |
2 files changed, 11 insertions, 9 deletions
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 4c679913..e021c870 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -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 @@ -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 --> |