Skip to content

Commit bfab692

Browse files
committed
chore(docs): Update contributing guidelines
1 parent cff581f commit bfab692

File tree

1 file changed

+21
-0
lines changed

1 file changed

+21
-0
lines changed

CONTRIBUTING.md

+21
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,26 @@
11
# Contributing to ng-redux
22

3+
## Developing ng-redux
4+
5+
To run the project, simply `npm install`. Then, run tests via `npm run test` or build the entire project via `npm build`.
6+
7+
## Commit convention
8+
9+
ng-redux uses [`standard-version` convention](https://github.com/conventional-changelog/standard-version) which basically looks like this:
10+
11+
```bash
12+
typeOfCommit(locationOfChanges): Commit message
13+
```
14+
15+
Examples:
16+
17+
```bash
18+
fix(lib): Fix ng-redux library issue
19+
feat(build): Build system test watch
20+
```
21+
22+
And so on. The commits are then compiled into the changelog along with each release.
23+
324
## Release process
425

526
For any contributors with release rights:

0 commit comments

Comments
 (0)