| 1 | # Contributing
|
| 2 |
|
| 3 | New contributions are welcomed. Follow this guide if you want to make one.
|
| 4 |
|
| 5 | ## Make a pull request
|
| 6 |
|
| 7 | Follow [Github guide](https://help.github.com/articles/creating-a-pull-request) to fork a repo
|
| 8 | and create a pull request.
|
| 9 |
|
| 10 | All bug fixes and new features should go to the [`master`](https://github.com/gemini-testing/glob-extra/tree/master) branch.
|
| 11 |
|
| 12 | ## Commit messages
|
| 13 |
|
| 14 | Commit messages should describe what have been changed and why. The first line should be wrapped
|
| 15 | to 50 characters, the second one should be blank. All other lines should be wrapped to 72 characters.
|
| 16 |
|
| 17 | ## Code style and static analysis
|
| 18 |
|
| 19 | Before submitting pull request, make sure your code passes all code style and static analysis checks.
|
| 20 | To do so, run:
|
| 21 |
|
| 22 | ```
|
| 23 | npm run lint
|
| 24 | ```
|
| 25 |
|
| 26 | ## Tests
|
| 27 |
|
| 28 | Make sure all tests are passing before submitting pull request:
|
| 29 |
|
| 30 | ```
|
| 31 | npm test
|
| 32 | ```
|
| 33 |
|
| 34 | If you are fixing the bug, add a test that fails without your patch and passes with it. If you are
|
| 35 | adding a feature, write a test for it. To see test coverage report run:
|
| 36 |
|
| 37 | ```
|
| 38 | npm run cover
|
| 39 | ```
|
| 40 |
|
| 41 | ## Issues reporting
|
| 42 |
|
| 43 | When submitting an issue please do following:
|
| 44 |
|
| 45 | 1. [Search](https://github.com/gemini-testing/glob-extra/issues) for same issues on github in order to prevent duplicates
|
| 46 | 2. Provide the most detailed issue description so we will additional info to work with
|
| 47 |
|
| 48 | 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.
|