From 8f4adce1993d873e77593b9063997a5134be3d59 Mon Sep 17 00:00:00 2001 From: Alejandro Saenz Date: Fri, 15 May 2020 09:07:54 -0400 Subject: [PATCH] docs(contributing.md): modified pull request process Modified pull request process to include using commitizen and husky. furthermore, moved linting step to happen automatically with husky. --- CONTRIBUTING.md | 17 +++++++---------- 1 file changed, 7 insertions(+), 10 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f88238f5..6bf92e06 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -31,17 +31,14 @@ Any release from master will have a unique version 1. All work must be done in a fork off the dev branch 2. Ensure any install or build dependencies are removed -3. Increase version numbers [accordingly](#versioning) -4. The code must comply to the configured TSLint and Sass Lint rules -5. Open pull request on the `develop` branch of your fork -6. All Git commits within a PR must be - [signed off](https://git-scm.com/docs/git-commit#Documentation/git-commit.txt--s) - to indicate the contributor's agreement with the - [Developer Certificate of Origin](https://developercertificate.org/). -7. Linting should pass +3. All Git commits within a PR must be conventional commits using [commitizen](https://github.com/commitizen/cz-cli) and enforced by [husky](https://github.com/typicode/husky) + 1. Run `$ git cz` when committing changes +4. Increase version numbers [accordingly](#versioning) +5. The code must comply to the configured TSLint and Sass Lint rules +6. Open pull request on the `develop` branch of your fork -### Linting (Dependent on project) +### Linting ``` npm run lint -``` \ No newline at end of file +```