diff options
| author | ClementTsang <34804052+ClementTsang@users.noreply.github.com> | 2022-09-16 05:16:58 -0400 |
|---|---|---|
| committer | ClementTsang <34804052+ClementTsang@users.noreply.github.com> | 2022-09-16 05:16:58 -0400 |
| commit | 10efe75fbdd2e46d1a889fdb0d316ade450b08cd (patch) | |
| tree | eb90aaa00eaf86e2c4263b98ab8daed50a109c89 /docs | |
| parent | de788244701707d4c6955bd8aef3e1067bd5c4fd (diff) | |
docs: update some contribution documentation
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/content/contribution/issues-and-pull-requests.md | 6 |
1 files changed, 4 insertions, 2 deletions
diff --git a/docs/content/contribution/issues-and-pull-requests.md b/docs/content/contribution/issues-and-pull-requests.md index e31d423a..c4d9f3de 100644 --- a/docs/content/contribution/issues-and-pull-requests.md +++ b/docs/content/contribution/issues-and-pull-requests.md @@ -27,5 +27,7 @@ The expected workflow for a pull request is: 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! +5. Ask/wait for a maintainer to review your pull request. + - Check if tests pass. These consist of clippy lints, rustfmt checks, and basic tests. + - 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. |