From 6684fafd69bdfe1e0e7c63c64dd7f1d657082a66 Mon Sep 17 00:00:00 2001 From: tormozz48 Date: Sun, 4 Sep 2016 10:48:41 +0300 Subject: [PATCH] Add CONTRIBUTING.md documentation file --- CONTRIBUTING.md | 48 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 48 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..81c764f --- /dev/null +++ b/CONTRIBUTING.md @@ -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.