Add section on stacking pull requests to Pull Requests guide

Open
#51 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

Difficulty
1/5
Estimated time
Under an hour
Newbie friendliness
50/100
Issue type
Documentation
Clarity
Mostly clear
Activity status
Stale
Domain
documentation

Research direction

Open the Pull Requests guide and locate the section covering dependent or stacked pull requests. Add the listed advice about keeping later PRs in draft, avoiding merges between non-first PRs, and rebasing the remaining stack after the first PR merges. Done means the guide clearly explains these practices.

Written by the indexing model from the issue text.

Description

team-wallet-framework

If you have a set of changes that you need to split up into separate stages, and some of those stages are dependent on each other, you'll need to create PRs that depend on each other. There's some specific advice around creating stacked pull requests. Specifically,

  • keep all PRs in the stack except the first in draft (because of the next point)
  • you never want to merge a PR that's not the first in the stack into another that's also not the first — when the first PR is merged, you need to rebase all other PRs
Dominant language
JavaScript
Stars
86
Forks
42
No merged PRs in 30d

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from MetaMask/contributor-docs

All issues in MetaMask/contributor-docs

Similar issues

More JavaScript issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.