1berry/nodejs
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

doc: remove "feature branch" jargon

Browse Source 
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: https://github.com/nodejs/node/pull/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>
This commit is contained in:
Rich Trott 2016-08-19 21:57:51 -07:00 committed by James M Snell
parent 013d76cb73
commit d6d3229603
1 changed files with 5 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

10
CONTRIBUTING.md
View File

@ -74,10 +74,10 @@ does not align with the project team. Node.js has two IRC channels,
### Step 2: Branch ### Step 2: Branch
Create a feature branch and start hacking: Create a branch and start hacking:
```text ```text
$ git checkout -b my-feature-branch -t origin/master $ git checkout -b my-branch -t origin/master
``` ```
### Step 3: Commit ### Step 3: Commit
@ -184,15 +184,15 @@ core modules.
### Step 6: Push ### Step 6: Push
```text ```text
$ git push origin my-feature-branch $ git push origin my-branch
``` ```
Go to https://github.com/yourusername/node and select your feature branch. Go to https://github.com/yourusername/node and select your branch.
Click the 'Pull Request' button and fill out the form. Click the 'Pull Request' button and fill out the form.
Pull requests are usually reviewed within a few days. If there are comments Pull requests are usually reviewed within a few days. If there are comments
to address, apply your changes in a separate commit and push that to your to address, apply your changes in a separate commit and push that to your
feature branch. Post a comment in the pull request afterwards; GitHub does branch. Post a comment in the pull request afterwards; GitHub does
not send out notifications when you add commits. not send out notifications when you add commits.
<a id="developers-certificate-of-origin"></a> <a id="developers-certificate-of-origin"></a>