From 215b040f0d8cd69af13e1796acab01aa94f19aa2 Mon Sep 17 00:00:00 2001
From: Shivam Mathur <shivam_jpr@hotmail.com>
Date: Sat, 31 Oct 2020 14:55:27 +0530
Subject: [PATCH] Fix contribution docs

---
 .github/CONTRIBUTING.md          | 20 +++++++++++++-------
 .github/PULL_REQUEST_TEMPLATE.md |  2 +-
 package.json                     |  2 +-
 3 files changed, 15 insertions(+), 9 deletions(-)

diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
index ba2c7186..4620654f 100644
--- a/.github/CONTRIBUTING.md
+++ b/.github/CONTRIBUTING.md
@@ -18,13 +18,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:
@@ -41,6 +34,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 6eb548a2..524b7de4 100644
--- a/.github/PULL_REQUEST_TEMPLATE.md
+++ b/.github/PULL_REQUEST_TEMPLATE.md
@@ -30,7 +30,7 @@ This PR [briefly explain what it does]
 > 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 link).
+- [ ] I have tested the changes in an integration test (If yes, provide workflow YAML and link).
 
 <!--
 - Please target the develop branch when submitting the pull request.
diff --git a/package.json b/package.json
index e5072766..4f7e71d9 100644
--- a/package.json
+++ b/package.json
@@ -6,7 +6,7 @@
   "main": "dist/index.js",
   "scripts": {
     "build": "tsc",
-    "lint": "eslint **/*.ts --cache",
+    "lint": "eslint **/*.ts --cache --fix",
     "format": "prettier --write **/*.ts && git add .",
     "format-check": "prettier --check **/*.ts",
     "release": "ncc build src/install.ts -o dist && git add -f dist/",