-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: 📝 add sections on making or dealing with stacked PRs #229
Open
lwjohnst86
wants to merge
1
commit into
main
Choose a base branch
from
docs/add-details-about-stacked-pull-requests
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -25,13 +25,30 @@ guidelines: | |
- After creating a pull request, add it to the relevant GitHub Project | ||
since this is where we keep an overview of what each of us is | ||
currently working on. | ||
- As you work on your branch and it starts growing too large in scope | ||
and size, strongly consider creating "stacked pull requests" by | ||
making a new branch on your current working branch and submit a new | ||
pull request on top of the parent pull request branch. | ||
- In the pull request description, try to explain *why* you made the | ||
changes in the pull request, rather than the *what*. | ||
|
||
If your task is too large in scope, modifies or adds many new files, or | ||
has several complicated pieces, *strongly* consider making "stacked pull | ||
requests". A stacked pull request is a pull request that is made on top | ||
of another pull request. This way, you can separate the changes into | ||
smaller, more manageable pieces that can be reviewed more easily and | ||
quickly since larger pull requests take longer and are more difficult to | ||
review. When making Stacked pull requests, follow these general | ||
guidelines: | ||
|
||
- When making the first, base pull request, write in the description | ||
that this will be a stacked pull request so that no one should merge | ||
it, only until all the stacked pull requests are ready. | ||
- As each stacked pull request is ready for review, team members will | ||
review and make suggestions as needed. As the author, you'll need to | ||
make sure all suggestions are merged downstream to the later pull | ||
requests by rebasing. | ||
Comment on lines
+43
to
+46
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. So, authors of stacked PRs are responsible for rebasing each stacked PR to the base PR? |
||
- Once all stacked pull requests are reviewed and approved, they will | ||
all be rebased onto the base pull request before being finally | ||
squashed into the base pull request. This way, the base pull request | ||
will contain all the changes from the stacked pull requests. | ||
|
||
::: callout-tip | ||
### Creating conventional branches using the VS Code extension | ||
|
||
|
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Do we have to wait until all stacked PRs have been approved or can we rebase each as soon as they’ve been approved?