Skip to content

Commit

Permalink
doc: update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
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 <info@bnoordhuis.nl>
  • Loading branch information
brendanashworth committed Apr 18, 2015
1 parent e61ee49 commit 6870764
Showing 1 changed file with 7 additions and 15 deletions.
22 changes: 7 additions & 15 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,13 +34,8 @@ $ git remote add upstream git://github.com/iojs/io.js.git

#### Which branch?

Now decide if you want your feature or bug fix to go into the master branch
or the stable branch. As a rule of thumb, bug fixes go into the stable branch
while new features go into the master branch.

The stable branch is effectively frozen; patches that change the io.js
API/ABI or affect the run-time behavior of applications get rejected. The
current stable branch is set as the default branch on GitHub.
For developing new features and bug fixes, the `master` branch should be pulled
and built upon.

#### Respect the stability index

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

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

#### Dependencies

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

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

(Where `v1.x` is the latest stable branch as of this writing.)


### Step 3: Commit

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

```text
$ git fetch upstream
$ git rebase upstream/v1.x # or upstream/master
$ git rebase upstream/master
```


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

You can run tests directly with node:
You can run tests directly with iojs:

```text
$ node ./test/parallel/test-streams2-transform.js
$ iojs ./test/parallel/test-streams2-transform.js
```


Expand Down

0 comments on commit 6870764

Please sign in to comment.