Skip to content
This repository was archived by the owner on Oct 1, 2018. It is now read-only.

Commit b6344d9

Browse files
authored
Merge pull request #46 from knittingcodemonkey/commitScriptDocumentation
docs(CONTRIBUTING.md, README.md): Instructions regarding commit script
2 parents aec9e36 + 8a18c13 commit b6344d9

File tree

2 files changed

+10
-1
lines changed

2 files changed

+10
-1
lines changed

CONTRIBUTING.md

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,8 @@ Before you submit your Pull Request (PR) consider the following guidelines:
5353
is necessary because release notes are automatically generated from these messages.
5454
5555
```shell
56-
git commit -a
56+
git add .
57+
npm run commit
5758
```
5859
Note: the optional commit `-a` command line option will automatically "add" and "rm" edited files.
5960

README.md

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -32,3 +32,11 @@ The build and test structure is fairly primitive at the moment. There are variou
3232
- build: build artifacts will be stored in the `dist/` directory
3333
- build-prod: builds for production using the `--prod` flag
3434
- commit: runs git commit wizard for passing rxjs-github-bot message validator
35+
36+
## Committing
37+
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.
38+
39+
```shell
40+
git add .
41+
npm run commit
42+
```

0 commit comments

Comments
 (0)