From dd0123cf4924a7e7f14d7bc1d8b3e7ce12dd8f06 Mon Sep 17 00:00:00 2001 From: merxgrc Date: Fri, 5 Sep 2025 22:47:30 -0700 Subject: [PATCH] docs(DEV_README): Adds Commit message convention --- DEV_README.md | 32 +++++++++++++++++++++++++++++++- 1 file changed, 31 insertions(+), 1 deletion(-) diff --git a/DEV_README.md b/DEV_README.md index be3c742..46c8a92 100644 --- a/DEV_README.md +++ b/DEV_README.md @@ -48,4 +48,34 @@ DELETE /api/items/{id} → Delete an item * Add authentication and user accounts -* Deploy to cloud (AWS/Azure/GCP/OCI) \ No newline at end of file +* Deploy to cloud (AWS/Azure/GCP/OCI) + +## Commit Message Conventions + +This project follows [Conventional Commits](https://www.conventionalcommits.org/) for clear and consistent commit history. + +### Common Types +- **feat**: a new feature for the user (e.g., new endpoint, new class) + - `feat(controller): add GET /items endpoint` +- **fix**: a bug fix + - `fix(service): correct null pointer in ItemService` +- **chore**: maintenance tasks that don’t affect functionality (refactors, moving files, updating configs) + - `chore(structure): move ItemController into controller package` +- **test**: adding or updating tests only + - `test(repository): add unit tests for ItemRepository` +- **docs**: documentation changes + - `docs(readme): add commit convention guide` +- **refactor**: code changes that improve structure but don’t change behavior + - `refactor(model): simplify Item constructor` +- **style**: formatting, whitespace, semicolons, etc. (no code logic changes) + - `style: reformat code with Google Java Style` +- **build**: changes to build system, dependencies, or CI/CD + - `build(ci): add GitHub Actions workflow for Maven` + +### Format +(optional scope): short description + +### Examples +feat(controller): add GET /items endpoint +fix(service): correct bug in inventory calculation +chore(deps): update Spring Boot to 3.5.5 \ No newline at end of file