diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 7289b06f..53468df7 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -53,7 +53,8 @@ Before you submit your Pull Request (PR) consider the following guidelines: is necessary because release notes are automatically generated from these messages. ```shell - git commit -a + git add . + npm run commit ``` Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files. diff --git a/README.md b/README.md index fcea8945..1749271f 100644 --- a/README.md +++ b/README.md @@ -32,3 +32,11 @@ The build and test structure is fairly primitive at the moment. There are variou - build: build artifacts will be stored in the `dist/` directory - build-prod: builds for production using the `--prod` flag - commit: runs git commit wizard for passing rxjs-github-bot message validator + +## Committing +It is strongly recommended that when creating a commit, you follow this procedure to start the commit wizard. It will aid you on creating valid commit messages. + + ```shell + git add . + npm run commit + ``` \ No newline at end of file