Skip to content

Commit 6fe7e73

Browse files
authored
Document (#6)
* docs: add flutter-architecture.md * docs: add guildlines/conventional-commit.md * docs: add database-schema.md * add readme.md * chore: fix misspelled folder name
1 parent b0929e4 commit 6fe7e73

1 file changed

Lines changed: 24 additions & 0 deletions

File tree

Lines changed: 24 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,24 @@
1+
## 📌 Git Commit Convention
2+
3+
To maintain a clean, readable, and trackable commit history, all team members **MUST** adhere to the following commit guidelines.
4+
5+
### 1. Standard Syntax
6+
`<type>(<scope>): <short_description>`
7+
8+
### 2. Allowed Types
9+
10+
| Icon | Type | Description | Example |
11+
| :---: | :--- | :--- | :--- |
12+
|| **feat** | Adds a new feature to the application. | `feat(auth): add JWT login API` |
13+
| 🐛 | **fix** | Patches a bug or resolves an issue. | `fix(cart): resolve incorrect total price calculation` |
14+
| ♻️ | **refactor**| Restructures code without changing existing logic or adding features. | `refactor(product): clean up IProductService interface` |
15+
| 📝 | **docs** | Adds or updates documentation (README, diagrams, etc.). | `docs(ci): update SonarCloud workflow` |
16+
| 🔧 | **chore** | Maintenance tasks, configurations, or dependency updates. | `chore(deps): bump Newtonsoft.Json to 10.0.4` |
17+
| 🚀 | **perf** | Code changes that improve performance. | `perf(db): add index to Product table for faster queries` |
18+
19+
### 3. Golden Rules
20+
- The `type` and `scope` MUST strictly be in **lowercase**.
21+
- The description must be clear, concise, and straight to the point.
22+
- **NEVER** push code with meaningless commit messages such as: `update`, `fix bug`, `done part A`, `asdfgh`.
23+
24+
Reference: [Conventional Commit](https://www.conventionalcommits.org/en/v1.0.0/)

0 commit comments

Comments
 (0)