Commit messages
Example of a good commit message:
Feature ( Organisms - Badge ) Add a swirly separator by default
Commit message
To compose a commit message like shown above, we always use the template as shown below.
[SUBCOMPONENT] and [OPTIONAL EXTRA DETAILS] are optional.
[TYPE] ( [COMPONENT] - [SUBCOMPONENT (IF NEEDED) ] ) [COMMENT]
[OPTIONAL EXTRA DETAILS]
🗃️ Type
For [TYPE] we use a predefined list of possibilities. Please do not deviate from this list:
| Title | Description |
|---|---|
| Feature | A new feature |
| Fix | A bug fix |
| Refactor | A code change that neither fixes a bug nor adds a feature |
| Removal | Removal of redundant files (noun, like all other - instead of a verb) |
| Docs | Documentation only changes |
| Style | Changes in code style that do not affect the meaning of the code (white-space, formatting, missing semi-colons, etc) |
| Perf | A code change that improves performance |
| Test | Adding missing tests or correcting existing tests |
| Build | Changes that affect the build system or external dependencies (example scopes: webpack, npm) |
| CI | Changes to our CI configuration files and scripts (i.e. CircleCI, Docker) |
| Revert | Reverts a previous commit |
| Chore | Other changes that don't modify src or test files (changelog, eslint configs, etc) |
🗂️ Component
Name of the component you're modifying. This makes it faster for yourself and your fellow developers to track down any changes/issues in case of problems arising during testing. Name of subcomponent is optional, and needs to be added when relevant.
📝 Comment
Always add a clear but concise comment explaining the intention of the change committed.
📑 Extra details (optional)
Only add when really needed. In most cases the comment and the change itself should say it all.
The section you're currently reading (Using Helium) is meant for most day-to-day working with a Helium project and/or getting started with Helium projects. Need more specific information about certain tasks? Try the 🎓 Guides