Skip to content

Commit

Permalink
Added a few tweaks to the contributor readme marionettejs#3185
Browse files Browse the repository at this point in the history
  • Loading branch information
Scott Walton committed Oct 23, 2016
1 parent f057e3d commit 5d67889
Showing 1 changed file with 9 additions and 4 deletions.
13 changes: 9 additions & 4 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,6 +87,9 @@ When submitting your pull request, you need to determine whether to base off
* If you're submitting documentation for a new feature, base off `next`
* If you're submitting documentation for the current release, base off `master`

If you're still unsure which branch to request against, base off `next`. If we
need you to change it, we'll just ask.

### Submitting a Great Patch

We want Marionette to provide a great experience to developers and help you
Expand All @@ -107,6 +110,7 @@ as part of our release process.
The Marionette coding conventions are provided in the ESLint configuration
included in the repository. Most IDEs and text editors will provide, or allow
for, a plugin for ESLint to read the `.eslintrc` file.

For areas where the configuration provides no guidance, try to stick to the
conventions in the file you're editing.

Expand All @@ -127,10 +131,9 @@ to discuss further.

## Running Tests

* via command-line by running `npm test`
* in the browser by running `npm run test-browser`

To see the test matrix - run `npm run coverage`
* Command line: `npm test`
* In-browser: `npm run test-browser`
* Test matrix: `npm run coverage`

## Our Release Process

Expand All @@ -141,6 +144,8 @@ expect your changes to make it into a Marionette release.
We run two separate development branches: `master` and `next` representing the
current patch version and the next planning major/minor version respectively.

The release process is most easily explained by example.

### Releasing Patches

To demonstrate this, this process uses a hypothetical release `3.0.4`.
Expand Down

0 comments on commit 5d67889

Please sign in to comment.