Skip to content

updated commit message etiquette - added type to distinguish nature of commits #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
AiMohitGaur wants to merge 1 commit into
base: master
Choose a base branch
from
Open

updated commit message etiquette - added type to distinguish nature of commits #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
15 changes: 14 additions & 1 deletion branch_protection.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,20 @@

## 3. Additional GitHub Etiquette

- **Commit Messages**: Use meaningful commit messages following the format: `[Jira_ID] Brief description of change`
- **Commit Messages**: Use meaningful commit messages following the format: `<type> (file/api/controller/keyword): short description (<Jira_ID>)`, **type** here refers to:
- **fix**: use when you are fixing a bug or error in the code
- ex - linting errors, or bug fix like missing edge case handling
- message would look like: `fix (api_utils - linting): fixed linting error - sorted the imports (LM-0000)`
- **update**: use when you are updating an existing feature/logic or extending the functionality
- ex - you added json file handling in export function
- message would look like: `update (/export - json files): added logic to export json files by converting csv files to json (LM-0000)`
- **hotfix**: use when you are pushing a patch work (generally p1/p2 issues), though not a full fledged solution but will unblock the user
- ex: user not able to view portfolio because the underlying data type is different
- message would look like: `hotfix (get portfolio - datatype): converted str type col total-buildings to int (AI-0000)`
- **feature**: use when you are adding new functionality
- ex - added notification feature when the export files are ready
- message would look like: `feature (/export - notification): added notification feature when export files are ready for download (LM-0000)`

- **Rebasing**: Keep your branch updated with `dev` by regularly rebasing.
- **Merging**: Use squash and merge to keep a clean commit history.
- **Conflict Resolution**: Ensure conflicts are resolved before requesting a review.
Expand Down