Skip to content

Latest commit

 

History

History
62 lines (42 loc) · 1.43 KB

CONTRIBUTING.md

File metadata and controls

62 lines (42 loc) · 1.43 KB

contribution guidelines

I shall hereby declare some ground and non-negotiable rules when contributing to @knowscount/vue-lib.

code style (eslint coming soon)

indentation

  1. type: tab
  2. size: four

semicolon

no.

naming functions

camelCase.

semantic commit messages

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

<scope> is optional

example

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

More Examples:

  • 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)

References:

issues

read this book.