- Create an Issue before starting development.
- Create a new branch from the
Devbranch of the origin repository. - Branch naming conventions:
- 🚀 Feature development →
feature/#<Issue Number> - 🎨 Refactoring →
refactor/#<Issue Number> - 🐛 Bug fixes →
bug/#<Issue Number>
- 🚀 Feature development →
- Fetch the newly created branch (
feature,refactor, orbug) to your local repository. - Checkout to the branch and start development.
- Create a Pull Request (PR) referencing the Issue.
- Follow the PR title format:
- ✨ Feature development →
✨ Feature - Description (#PR Number)- Example:
✨ Feature - Implement FCM integration (#123)
- Example:
- 🎨 Refactoring →
🎨 Refactor - Description (#PR Number)- Example:
🎨 Refactor - Renamed folders and completed integration test (#124)
- Example:
- ❗ Bug fixes →
❗ Bug - Description (#PR Number)- Example:
❗ Bug - Fixed folder name issue and tested integration (#125)
- Example:
- ✨ Feature development →
- Code Review & Approval:
- team members review the PR.
- The last person to approve performs the Confirm Squash Merge.
| Commit Type | Description |
|---|---|
| Feat | Add new features |
| Fix | Fix bugs |
| Docs | Modify documentation |
| Style | Code formatting, missing semicolons, no changes to the code itself |
| Refactor | Code refactoring |
| Test | Add test code, refactor test code |
| Chore | Modify package manager, and other miscellaneous changes (e.g., .gitignore) |
| Design | Change user UI design, such as CSS |
| Comment | Add or modify necessary comments |
| Rename | Only changes to file or folder names or locations |
| Remove | Only performing the action of deleting files |
| Icon | Code | Description |
|---|---|---|
| 🧑🏻🎨 | :art |
Improve code structure/formatting |
| ⚡️ | :zap |
Performance improvement |
| 🔥 | :fire |
Delete code/files |
| 🐛 | :bug |
Fix bugs |
| 🚑 | :ambulance |
Urgent fixes |
| ✨ | :sparkles |
Introduce new features |
| 💄 | :lipstick |
Add/modify UI/style files |
| ⏪ | :rewind |
Revert changes |
| 🔀 | :twisted_rightwards_arrows |
Merge branches |
| 💡 | :bulb |
Add/modify comments |
| 🗃 | :card_file_box |
Database-related changes |