-
Notifications
You must be signed in to change notification settings - Fork 10.3k
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
[contributing] update docs on guides & contributions (#20057)
* add missing steps to the docs setup instructions * chore: contributing info for guide types * add instructions on pushing to remote forks * remove extra line from doc-links * add note about other guides to Style Guide * Apply suggestions from code review Co-Authored-By: Aisha Blake <[email protected]> Co-Authored-By: LB <[email protected]>
- Loading branch information
1 parent
7bcbd02
commit b5c09e6
Showing
7 changed files
with
33 additions
and
5 deletions.
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
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 |
---|---|---|
|
@@ -24,6 +24,8 @@ Some general things to verify in a pull request are: | |
|
||
> 💡 When looking at a PR for the first time, it can help to read up on linked issues or [RFCs](/contributing/rfc-process/) (if there are any) to gain context on what the PR intends to add or fix. | ||
Note for Gatsby Core or Learning team members: if a PR has merge conflicts or needs a little help to push it across the finish line, contributing directly to a fork or branch can be a great way to resolve it. See notes on [pushing to a remote fork in Git](#pushing-changes-to-a-remote-fork). | ||
|
||
### Type Specific Guidelines | ||
|
||
Each kind of PR also requires a different set of specific checks from us before they are merged in. | ||
|
@@ -140,6 +142,18 @@ These are bad PR titles because they are generic, don't communicate the change p | |
- Be objective and limit nitpicks (a few are fine if they add value or improve code readability) | ||
- Don't suggest and expect changes out of scope which are best addressed in a separate PR | ||
|
||
## Pushing changes to a remote fork | ||
|
||
Sometimes the easiest way to unblock a stalled PR is to sort out merge conflicts or apply remaining suggestions. When the GitHub UI won't cut it, you can (often) apply changes directly to someone's remote fork with Git: | ||
|
||
- Add their Gatsby fork as a remote:<br />`git remote add <forkname> [email protected]:<username>/gatsby.git` | ||
- Fetch the branches:<br />`git fetch <forkname>` | ||
- Check out their branch locally:<br />`git checkout -b <branch-name> <forkname>/<branch-name>` | ||
- Make your changes, add some commits | ||
- Push branch to the remote fork (also see [Gotchas](#gotchas) below):<br /> `git push <forkname> head:<branch-name>` | ||
|
||
Alternatively, you can manage forks and branches with [hub](https://github.com/github/hub). | ||
|
||
## Rights and Permissions | ||
|
||
### Who can review a PR? | ||
|
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
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