Skip to content

Commit

Permalink
Update CONTRIBUTING.md
Browse files Browse the repository at this point in the history
  • Loading branch information
mxstbr committed Aug 16, 2016
1 parent 0e76874 commit 62b904b
Showing 1 changed file with 10 additions and 5 deletions.
15 changes: 10 additions & 5 deletions .github/CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -69,6 +69,11 @@ project's developers might not want to merge into the project.
Please adhere to the coding conventions used throughout a project (indentation,
accurate comments, etc.) and any other requirements (such as test coverage).

Since the `master` branch is what people actually use in production, we have a
`dev` branch that unstable changes get merged into first. Only when we
consider that stable we merge it into the `master` branch and release the
changes for real.

Adhering to the following process is the best way to get your work
included in the project:

Expand All @@ -86,22 +91,22 @@ included in the project:
2. If you cloned a while ago, get the latest changes from upstream:

```bash
git checkout master
git pull upstream master
git checkout dev
git pull upstream dev
```

3. Create a new topic branch (off the main project development branch) to contain your feature, change, or fix:
3. Create a new topic branch (off the `dev` branch) to contain your feature, change, or fix:

```bash
git checkout -b <topic-branch-name>
```

4. Commit your changes in logical chunks. Please adhere to these [git commit message guidelines](http://tbaggery.com/2008/04/19/a-note-about-git-commit-messages.html) or your code is unlikely be merged into the main project. Use Git's [interactive rebase](https://help.github.com/articles/about-git-rebase/) feature to tidy up your commits before making them public.

5. Locally merge (or rebase) the upstream development branch into your topic branch:
5. Locally merge (or rebase) the upstream dev branch into your topic branch:

```bash
git pull [--rebase] upstream master
git pull [--rebase] upstream dev
```

6. Push your topic branch up to your fork:
Expand Down

0 comments on commit 62b904b

Please sign in to comment.