Skip to content

Commit

Permalink
doc: remove "feature branch" jargon
Browse files Browse the repository at this point in the history
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>
  • Loading branch information
Trott authored and MylesBorins committed Oct 26, 2016
1 parent d676467 commit 26e695c
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -75,10 +75,10 @@ does not align with the project team. Node.js has two IRC channels,

### Step 2: Branch

Create a feature branch and start hacking:
Create a branch and start hacking:

```text
$ git checkout -b my-feature-branch -t origin/master
$ git checkout -b my-branch -t origin/master
```

### Step 3: Commit
Expand Down Expand Up @@ -185,15 +185,15 @@ core modules.
### Step 6: Push

```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.

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
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.

<a id="developers-certificate-of-origin"></a>
Expand Down

0 comments on commit 26e695c

Please sign in to comment.