From 5865982519a31805dd0a187357648c1bf90df747 Mon Sep 17 00:00:00 2001 From: Shivam Mathur Date: Sat, 31 Oct 2020 14:55:27 +0530 Subject: [PATCH] Fix contribution docs --- .github/CONTRIBUTING.md | 20 +++++++++++++------- .github/PULL_REQUEST_TEMPLATE.md | 7 ++++++- package.json | 2 +- 3 files changed, 20 insertions(+), 9 deletions(-) diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md index e0ee09fd..b2926576 100644 --- a/.github/CONTRIBUTING.md +++ b/.github/CONTRIBUTING.md @@ -17,13 +17,6 @@ Due to time constraints, you may not always get a quick response. Please do not ## Coding Guidelines -This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to format the code before committing it. - -```bash -$ npm run format -$ npm run lint -``` - ## Using setup-php from a Git checkout The following commands can be used to perform the initial checkout of setup-php: @@ -40,6 +33,19 @@ Install setup-php dependencies using [npm](https://www.npmjs.com/): $ npm install ``` +If you are using `Windows` configure `git` to handle line endings. + +```cmd +git config --local core.autocrlf true +``` + +This project comes with `.prettierrc.json` and `eslintrc.json` configuration files. Please run the following commands to fix and verify the code quality. + +```bash +$ npm run format +$ npm run lint +``` + ## Running the test suite After following the steps shown above, The `setup-php` tests in the `__tests__` directory can be run using this command: diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index f45c003f..40bd308f 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -26,7 +26,12 @@ This PR [briefly explain what it does] - [ ] I have run `npm run format` before the commit. - [ ] I have run `npm run lint` before the commit. - [ ] I have run `npm run release` before the commit. -- [ ] `npm test` returns with no unit test errors. +- [ ] `npm test` returns with no unit test errors and all code covered. + +> In case this PR edits any scripts: + +- [ ] I have checked the edited scripts for syntax. +- [ ] I have tested the changes in an integration test (If yes, provide workflow YAML and link).