In this document we will cover the guidelines for commit messages that must be followed by the developers.
The guidelines listed below are based on CM, but with some tweaks to fit our needs. These rules will help us create more descriptive commits so we can improve commit history consistency and automation.
type[module/scope(optional)]: description
[body(optional)]
[footer(optional)]
- fix - Correcting an error in the code
- feat - Adding a new feature to the code
- refactor - Refactoring some part of the code, not adding a new feature or fixing a bug 3.1. refactor! - Breaking change (! is for attention)
- revert - Reversing some part of the code/commit
- Finish v0.0.1 - Creating a release commit
- style - CSS, formatting, missing semicolons, syntax adjustment
- test - Adding Tests
- perf - Adding or adjusting code that improves the app's performance
- ci - Deployment Process
- chore - Changing/Adding build-related tools
- docs - Updating Documentation
When adding new functionality (e.g.): let users delete properties from listing page
feat[delete-properties]: Adding a way for users to delete properties from listing page
feat: Adding a way for users to delete properties from listing page
There's a bug in the currency input, which doesn't have the currency mask, but the input was designed to have the currency mask.
fix[shopping-cart]: Adding currency mask to the currency input
I thought of a way to improve the rendering time of the Properties page
perf[properties]: list of all properties
Improving loading time using server-side rendering
Removing support for node < 6
refactor!: drop support for Node 6
By default using Smart Git