From 8a18c1336a943d4aa0289f5f0ea5a39bfb570f2a Mon Sep 17 00:00:00 2001 From: Jennifer Luker Date: Wed, 18 Oct 2017 15:52:13 -0600 Subject: [PATCH] docs(CONTRIBUTING.md, README.md): Add instructions regarding commit script Add strong recommendation to use the commit script for creating commit messages https://github.com/ReactiveX/rxjs-docs/issues/19 --- CONTRIBUTING.md | 3 ++- README.md | 8 ++++++++ 2 files changed, 10 insertions(+), 1 deletion(-) 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