From cfd40317143f389508f5d480dde0a47cbdb2165b Mon Sep 17 00:00:00 2001 From: Anton Drukh Date: Mon, 6 Aug 2018 13:40:46 +0300 Subject: [PATCH] docs: unify contributing guidelines --- .github/CONTRIBUTING.md | 13 ++++++++----- CONTRIBUTING.md | 4 ---- 2 files changed, 8 insertions(+), 9 deletions(-) delete mode 100644 CONTRIBUTING.md diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index a68c412..685a7eb 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -31,15 +31,18 @@ To release a major you need to add `BREAKING CHANGE: ` to the start of the body ## Code standards -Ensure that your code adheres to the included `.jshintrc` and `.jscsrc` configs. +Ensure that your code adheres to the included `.eslintrc` config by running `npm run lint`. ## Sending pull requests -- new command line options are generally discouraged unless there's a *really* good reason - add tests for newly added code (and try to mirror directory and file structure if possible) - spell check -- PRs will not be code reviewed unless all tests are passing +- PRs will not be code reviewed unless all tests are passing (run `npm test`) -*Important:* when fixing a bug, please commit a **failing test** first so that Travis CI (or I can) can show the code failing. Once that commit is in place, then commit the bug fix, so that we can test *before* and *after*. +*Important:* when fixing a bug, please commit a **failing test** first demonstrate the current code is failing. Once that commit is in place, then commit the bug fix, so that we can test *before* and *after*. -Remember that you're developing for multiple platforms and versions of node, so if the tests pass on your Mac or Linux or Windows machine, it *may* not pass elsewhere. \ No newline at end of file +Remember that you're developing for multiple platforms and versions of node, so if the tests pass on your Mac or Linux or Windows machine, it *may* not pass elsewhere. + +## Contributor Agreement + +A pull-request will only be considered for merging into the upstream codebase after you have signed our [contributor agreement](https://github.com/snyk/snyk-gradle-plugin/blob/master/Contributor-Agreement.md), assigning us the rights to the contributed code and granting you a license to use it in return. If you submit a pull request, you will be prompted to review and sign the agreement with one click (we use [CLA assistant](https://cla-assistant.io/)). diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md deleted file mode 100644 index 45ed8e3..0000000 --- a/CONTRIBUTING.md +++ /dev/null @@ -1,4 +0,0 @@ -# Guidelines - -## Contributor Agreement -A pull-request will only be considered for merging into the upstream codebase after you have signed our [contributor agreement](https://github.com/snyk/snyk-gradle-plugin/blob/master/Contributor-Agreement.md), assigning us the rights to the contributed code and granting you a license to use it in return. If you submit a pull request, you will be prompted to review and sign the agreement with one click (we use [CLA assistant](https://cla-assistant.io/)).