Skip to content

Commit 6870764

Browse files
doc: update CONTRIBUTING.md
This commit: - fixes development branch (v1.x -> master) - updates stability index wording - use iojs binary instead of node PR-URL: #1466 Reviewed-By: Ben Noordhuis <[email protected]>
1 parent e61ee49 commit 6870764

File tree

1 file changed

+7
-15
lines changed

1 file changed

+7
-15
lines changed

CONTRIBUTING.md

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -34,13 +34,8 @@ $ git remote add upstream git://github.com/iojs/io.js.git
3434

3535
#### Which branch?
3636

37-
Now decide if you want your feature or bug fix to go into the master branch
38-
or the stable branch. As a rule of thumb, bug fixes go into the stable branch
39-
while new features go into the master branch.
40-
41-
The stable branch is effectively frozen; patches that change the io.js
42-
API/ABI or affect the run-time behavior of applications get rejected. The
43-
current stable branch is set as the default branch on GitHub.
37+
For developing new features and bug fixes, the `master` branch should be pulled
38+
and built upon.
4439

4540
#### Respect the stability index
4641

@@ -49,7 +44,7 @@ The rules for the master branch are less strict; consult the
4944

5045
In a nutshell, modules are at varying levels of API stability. Bug fixes are
5146
always welcome but API or behavioral changes to modules at stability level 3
52-
and up are off-limits.
47+
(Locked) are off-limits.
5348

5449
#### Dependencies
5550

@@ -71,12 +66,9 @@ does not align with the project team.
7166
Create a feature branch and start hacking:
7267

7368
```text
74-
$ git checkout -b my-feature-branch -t origin/v1.x
69+
$ git checkout -b my-feature-branch -t origin/master
7570
```
7671

77-
(Where `v1.x` is the latest stable branch as of this writing.)
78-
79-
8072
### Step 3: Commit
8173

8274
Make sure git knows your name and email address:
@@ -123,7 +115,7 @@ Use `git rebase` (not `git merge`) to sync your work from time to time.
123115

124116
```text
125117
$ git fetch upstream
126-
$ git rebase upstream/v1.x # or upstream/master
118+
$ git rebase upstream/master
127119
```
128120

129121

@@ -147,10 +139,10 @@ can use this syntax to run it exactly as the test harness would:
147139
$ python tools/test.py -v --mode=release parallel/test-stream2-transform
148140
```
149141

150-
You can run tests directly with node:
142+
You can run tests directly with iojs:
151143

152144
```text
153-
$ node ./test/parallel/test-streams2-transform.js
145+
$ iojs ./test/parallel/test-streams2-transform.js
154146
```
155147

156148

0 commit comments

Comments
 (0)