Skip to content

doc: remove "feature branch" jargon #8194

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Trott wants to merge 1 commit into from
Closed

doc: remove "feature branch" jargon #8194

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
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?")
  • Loading branch information
@Trott
Trott committed Aug 20, 2016
commit a2cf4796100293d0b1b57bd46c52b73f0b622ff5
10 changes: 5 additions & 5 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -74,10 +74,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 @@ -184,15 +184,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.
Copy link
Copy Markdown
Member

@targos targos Aug 20, 2016 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We should reword this part now that GitHub does send notifications about new commits. That can be done in another PR, I'm just thinking out loud.


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