Skip to content

Commit

Permalink
Add CONTRIBUTING.md documentation file
Browse files Browse the repository at this point in the history
  • Loading branch information
tormozz48 committed Sep 4, 2016
1 parent 898e57e commit 6684faf
Showing 1 changed file with 48 additions and 0 deletions.
48 changes: 48 additions & 0 deletions CONTRIBUTING.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,48 @@
# Contributing

New contributions are welcomed. Follow this guide if you want to make one.

## Make a pull request

Follow [Github guide](https://help.github.com/articles/creating-a-pull-request) to fork a repo
and create a pull request.

All bug fixes and new features should go to the [`master`](https://github.com/gemini-testing/glob-extra/tree/master) branch.

## Commit messages

Commit messages should describe what have been changed and why. The first line should be wrapped
to 50 characters, the second one should be blank. All other lines should be wrapped to 72 characters.

## Code style and static analysis

Before submitting pull request, make sure your code passes all code style and static analysis checks.
To do so, run:

```
npm run lint
```

## Tests

Make sure all tests are passing before submitting pull request:

```
npm test
```

If you are fixing the bug, add a test that fails without your patch and passes with it. If you are
adding a feature, write a test for it. To see test coverage report run:

```
npm run cover
```

## Issues reporting

When submitting an issue please do following:

1. [Search](https://github.com/gemini-testing/glob-extra/issues) for same issues on github in order to prevent duplicates
2. Provide the most detailed issue description so we will additional info to work with

Note that if no response for contributors questions will be provided in 1 week then issue may be considered as irrelevant/resolved and may be closed.

0 comments on commit 6684faf

Please sign in to comment.