Skip to content

Commit

Permalink
📝 Update contributing guidelines
Browse files Browse the repository at this point in the history
  • Loading branch information
elbywan committed Oct 3, 2017
1 parent c14ede7 commit b96022d
Showing 1 changed file with 14 additions and 1 deletion.
15 changes: 14 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,4 +37,17 @@ If a linter rule which is not already set in the tslint.json file is bothering y

If the modification is related to an existing issue, please mention the number in the commit message. (for instance: `closes #10`)

Always rebase your branch on top of the origin/master branch.
Also in order to generate a nice changelog file, please begin your commit message with an emoji corresponding to the change :

- :fire: `:fire:` -> breaking change
- :bug: `:bug:` -> bugfix
- :factory: `:factory:` -> new feature
- :art: `:art:` -> code improvements
- :checkered_flag: `:checkered_flag:` -> performance updates
- :white_check_mark: `:white_check_mark` -> test improvements
- :memo: `:memo:` -> documentation update
- :arrow_up: `:arrow_up:` -> package updates

Furthermore, starting the actual message content with an upper case and using the present tense and imperative mood would be great.

And last but not least, always rebase your branch on top of the origin/master branch !

0 comments on commit b96022d

Please sign in to comment.