Commit Guidelines

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

<scope> is optional

Types:

• feat: new feature added or any new implementation (eg. add push notification, implement Plot class)
• fix: bug fix
• docs: anything documentation related, including comments in-code; no production code change
• style: formatting; no production code change
• refactor: refactoring production code (eg. rename phone number variable, optmize inverse square root computation)
• test: adding tests, refactoring tests, etc; no production code change
• chore: regular code maintenance (eg. adjust project configuration settings, rename a file or a folder)

Keep in mind

1. favor smaller and more atomic commits in place of big commits that change a lot of stuff in a lot of files.

Example

feat: add search feature
^--^  ^----------------^
|     |
|     +-> Summary in present tense.
|
+-------> Type