Commit 26e695c
doc: remove "feature branch" jargon
In the context of the CONTRIBUTING.md document, there is no advantage to
describing the branch as a "feature branch" and the term may be
confusing. Just refer to it as a branch.
Context for the curious: The phrase "feature branch" in CONTIRUBTING.md
confused someone I was assisting today. It occured to me that the word
"feature" doesn't add anything and can be confusing. ("I'm doing a bug
fix so I don't need to create a feature branch, right?")
PR-URL: #8194
Reviewed-By: Michaël Zasso <mic.besace@gmail.com>
Reviewed-By: Ben Noordhuis <info@bnoordhuis.nl>
Reviewed-By: Evan Lucas <evanlucas@me.com>
Reviewed-By: Franziska Hinkelmann <franziska.hinkelmann@gmail.com>
Reviewed-By: James M Snell <jasnell@gmail.com>1 parent d676467 commit 26e695c
1 file changed
Lines changed: 5 additions & 5 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
@@ -75,10 +75,10 @@ does not align with the project team. Node.js has two IRC channels, | |||
| 75 | 75 | ||
| 76 | 76 | ### Step 2: Branch | |
| 77 | 77 | ||
| 78 | - Create a feature branch and start hacking: | ||
| 78 | + Create a branch and start hacking: | ||
| 79 | 79 | ||
| 80 | 80 | ```text | |
| 81 | - $ git checkout -b my-feature-branch -t origin/master | ||
| 81 | + $ git checkout -b my-branch -t origin/master | ||
| 82 | 82 | ``` | |
| 83 | 83 | ||
| 84 | 84 | ### Step 3: Commit | |
@@ -185,15 +185,15 @@ core modules. | |||
| 185 | 185 | ### Step 6: Push | |
| 186 | 186 | ||
| 187 | 187 | ```text | |
| 188 | - $ git push origin my-feature-branch | ||
| 188 | + $ git push origin my-branch | ||
| 189 | 189 | ``` | |
| 190 | 190 | ||
| 191 | - Go to https://github.com/yourusername/node and select your feature branch. | ||
| 191 | + Go to https://github.com/yourusername/node and select your branch. | ||
| 192 | 192 | Click the 'Pull Request' button and fill out the form. | |
| 193 | 193 | ||
| 194 | 194 | Pull requests are usually reviewed within a few days. If there are comments | |
| 195 | 195 | to address, apply your changes in a separate commit and push that to your | |
| 196 | - feature branch. Post a comment in the pull request afterwards; GitHub does | ||
| 196 | + branch. Post a comment in the pull request afterwards; GitHub does | ||
| 197 | 197 | not send out notifications when you add commits. | |
| 198 | 198 | ||
| 199 | 199 | <a id="developers-certificate-of-origin"></a> | |
0 commit comments