Skip to content

Latest commit

 

History

History
50 lines (32 loc) · 1.16 KB

CONTRIBUTE.md

File metadata and controls

50 lines (32 loc) · 1.16 KB

Stack

Language: ReactJS + TypeScript

Formatter: Prettier

Documentation: StorybookJS

Testing: Jest

  • No tutorial yet...

PR Convention

Always squash and merge

Naming convention

Format: <type>(<scope>): <subject>

<scope> is optional

Types:

  • feat: (new feature for the user, not a new feature for build script)
  • fix: (bug fix for the user, not a fix to a build script)
  • docs: (changes to the documentation)
  • style: (formatting, missing semi colons, etc; no production code change)
  • refactor: (refactoring production code, eg. renaming a variable)
  • test: (adding missing tests, refactoring tests; no production code change)
  • chore: (updating grunt tasks etc; no production code change)

Example

feat: add hat wobble
^--^  ^------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type: chore, docs, feat, fix, refactor, style, or test.

Reference: https://gist.github.com/joshbuchea/6f47e86d2510bce28f8e7f42ae84c716