Skip to content

Commit 16c1f6d

Browse files
committed
adding and recommeding Squashing and merging a long-running branch ref and proving the option of rebase if need it (which is something I find it usuefull in many of other projects) #422
1 parent 43d3337 commit 16c1f6d

File tree

1 file changed

+2
-8
lines changed

1 file changed

+2
-8
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -49,21 +49,15 @@ git push origin ISSUENUMBER-branch-name
4949
2. Click `Compare and pull request` and create PR for the associated branch.
5050
3. Type a title and description of your PR and create PR
5151
4. Please keep your PR in sync with the base branch.
52+
It is recommended that you use [Squashing and merging a long-running branch](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/incorporating-changes-from-a-pull-request/about-pull-request-merges#squashing-and-merging-a-long-running-branch).
53+
Otherwise, you have the option to rebase your `FEATURE_BRANCH` branch with the base branch (e.g. `main`).
5254
```
5355
git checkout main
5456
git pull origin main
5557
git checkout FEATURE_BRANCH
5658
git rebase main
5759
git push --force origin FEATURE_BRANCH
5860
```
59-
4.1 In case you are in a different `MY_FEATURE_BRANCH` branch, follow:
60-
```
61-
git checkout FEATURE_BRANCH
62-
git pull origin FEATURE_BRANCH
63-
git checkout MY_FEATURE_BRANCH
64-
git rebase FEATURE_BRANCH
65-
git push --force origin MY_FEATURE_BRANCH
66-
```
6761
5. Run `pre-commit` to tidy up code and documentation (see next section).
6862
6. Request a PR review.
6963
See [collaborating-with-pull-requests](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests) for further details.

0 commit comments

Comments
 (0)