Skip to content

Commit

Permalink
Add branching model section to the contributing docs
Browse files Browse the repository at this point in the history
In order to allow reviewers of PRs to get quicker
into contex and estimate review time of a PR,
adding a section to specify a branching model for
the project. Basically it takes the feature and
bugfix features of git-flow.
  • Loading branch information
Daniela Valero committed Dec 16, 2016
1 parent 10780ef commit 711da16
Showing 1 changed file with 32 additions and 6 deletions.
38 changes: 32 additions & 6 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,24 +37,50 @@ yarn link
yarn link webpack-cli
```

To run the entire test suite use:

```bash
yarn test
```
* To run the entire test suite use: `yarn test`

## Editor Config

The [.editorconfig](https://github.com/webpack/webpack-cli/blob/master/.editorconfig) in the root should ensure consistent formatting. Please make sure you've [installed the plugin](http://editorconfig.org/#download) if your text editor needs one.

## Branching Model

We based our branching model on [git flow](http://nvie.com/posts/a-successful-git-branching-model/). Instead of working with a `develop` base branch, we use instead the `master` branch. We do it to ease a bit the workflow. However, we find useful adding prefixes to the branches.

## Naming a branch

Making a branch in your fork for your contribution is helpful in the following ways:

* It allows you to submit more than one contribution in a single PR.
* It allows us to identify what your contribution is about from the branch name.

You will want to checkout the `master` branch locally before creating your new branch.

There are two types of branches:

* Feature
* Bugfix

### Features

If your contribution is something new, like a option for the cli, you can create a branch with the following prefix:

`feature/<the-new-feature>`

### Fixes

If you are fixing a existing bug, you can create a branch with the following prefix:

`bugfix/<the-fix>`

## Submitting Changes

After getting some feedback, push to your fork and submit a pull request. We
may suggest some changes, improvements or implementation alternatives.

In case you've got a small change in most of the cases your pull request would be accepted quicker.

### How to increase chance of having a pull request accepted?
## Submitting a good Pull Request

* Write tests
* Follow the existing coding style
Expand Down

0 comments on commit 711da16

Please sign in to comment.