Skip to content

Commit 65a6714

Browse files
authored
Merge pull request #3 from jsdevtom/correctContributionGuidlines
docs(contributing): add npm run commit instruction
2 parents d98965e + 0c83582 commit 65a6714

1 file changed

Lines changed: 4 additions & 2 deletions

File tree

CONTRIBUTING.md

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,7 @@
11
We're really glad you're reading this, because we need volunteer developers to help this project come to fruition. 👏
22

3+
This repo uses [commitizen](https://github.com/commitizen/cz-cli#commitizen-for-contributors) to allow simpler contribution.
4+
35
## Instructions
46

57
These steps will guide you through contributing to this project:
@@ -12,6 +14,6 @@ These steps will guide you through contributing to this project:
1214

1315
Keep in mind that after running `npm install` the git repo is reset. So a good way to cope with this is to have a copy of the folder to push the changes, and the other to try them.
1416

15-
Make and commit your changes. Make sure the commands npm run build and npm run test:prod are working.
17+
Make your changes and commit them with `npm run commit`. Make sure the commands npm run build and npm run test:prod are working.
1618

17-
Finally send a [GitHub Pull Request](https://github.com/alexjoverm/typescript-library-starter/compare?expand=1) with a clear list of what you've done (read more [about pull requests](https://help.github.com/articles/about-pull-requests/)). Make sure all of your commits are atomic (one feature per commit).
19+
Finally send a [GitHub Pull Request](https://github.com/jsdevtom/truegin/compare?expand=1) with a clear list of what you've done (read more [about pull requests](https://help.github.com/articles/about-pull-requests/)). Make sure all of your commits are atomic (one feature per commit).

0 commit comments

Comments
 (0)