diff options
| author | Madhav Jivrajani <madhav.jiv@gmail.com> | 2021-05-13 21:08:28 +0530 |
|---|---|---|
| committer | Madhav Jivrajani <madhav.jiv@gmail.com> | 2021-05-13 21:51:57 +0530 |
| commit | c4906d2ad9ac848df14c88f5d098328d7e82ab43 (patch) | |
| tree | 5763c42c6c042f81e6eff80ff8bb4fe1b1769b65 | |
| parent | 067bfb5e88df8a79aefa5fb818f2feca695025d7 (diff) | |
Add documentaion for tide/squash-on-merge to pull-request.md and contributor-cheatsheet
- adding documentation increases awareness that this label exists and can help PRs get merged quicker
- Manual squash causes removal of lgtm label and re-run of CI tests.
Signed-off-by: Madhav Jivrajani <madhav.jiv@gmail.com>
| -rw-r--r-- | contributors/guide/contributor-cheatsheet/README.md | 2 | ||||
| -rw-r--r-- | contributors/guide/pull-requests.md | 2 |
2 files changed, 3 insertions, 1 deletions
diff --git a/contributors/guide/contributor-cheatsheet/README.md b/contributors/guide/contributor-cheatsheet/README.md index e1722f2e..716eda4e 100644 --- a/contributors/guide/contributor-cheatsheet/README.md +++ b/contributors/guide/contributor-cheatsheet/README.md @@ -374,7 +374,7 @@ git rebase -i HEAD~3 git push --force ``` - +**Note**: you can also ask your reviewer to add the `tide/merge-method-squash` label to your PR (this can be done by a reviewer by issuing the command: `/label tide/merge-method-squash`), this will let the bot take care of squashing _all_ commits that are part of this PR and will not result in removal of the `LGTM` label (if already applied) or re-run of the CI tests. [contributor guide]: /contributors/guide/README.md [developer guide]: /contributors/devel/README.md diff --git a/contributors/guide/pull-requests.md b/contributors/guide/pull-requests.md index e556af8d..9bcc7c8f 100644 --- a/contributors/guide/pull-requests.md +++ b/contributors/guide/pull-requests.md @@ -291,6 +291,8 @@ For more information, see [squash commits](./github-workflow.md#squash-commits). Don't squash when there are independent changes layered to achieve a single goal. For instance, writing a code munger could be one commit, applying it could be another, and adding a precommit check could be a third. One could argue they should be separate pull requests, but there's really no way to test/review the munger without seeing it applied, and there needs to be a precommit check to ensure the munged output doesn't immediately get out of date. + +**Note**: you can also ask your reviewer to add the `tide/merge-method-squash` label to your PR (this can be done by a reviewer by issuing the command: `/label tide/merge-method-squash`), this will let the bot take care of squashing _all_ commits that are part of this PR and will not result in removal of the `LGTM` label (if already applied) or re-run of the CI tests. ## Commit Message Guidelines |