README.md

TOPLEARTH API SERVER REPOSITORY

---

📁 Application module packaging structure

com.gdsc.toplearth_server
├── application
│   ├── service
│   │   ├──
│   │   └──
│   ├── dto
│   │   ├── 
│   │   └── 
├── core
│   ├── annotation
│   │   ├── 
│   │   └── 
│   ├── common
│   │   ├── 
│   │   └──
│   ├── config
│   │   ├── 
│   │   └──
│   ├── constant
│   │   ├── 
│   │   └──
│   ├── exception
│   │   ├── 
│   │   └──
│   ├── interceptor
│   │   ├── 
│   │   └──
│   ├── security
│   │   ├── 
│   │   └──
│   ├── util
│   │   ├── 
│   │   └──
│   ├── validation
│   │   ├── 
│   │   └──
├── domain
│   ├── entity
│   │   ├── 
│   │   └── 
│   ├── repository
│   │   ├── 
│   │   └──  
├── infrastructure
│   ├── repository
│   │   └──  
│   ├── message
│   │   └── 
│   └── client
│   │    ├── 
│   │    └── 
└── presentation
    ├── controller
    │   ├── 
    │   └── 
    └── request
        ├──
        └── 

🎯 Commit Convention

Keyword	Description
Init	Initial project setup
Feat	Add a new feature
Fix	Fix a bug
Docs	Modify documentation
Style	Code formatting, no changes to the code logic
Refactor	Code refactoring
Test	Add or refactor test code
Chore	Package manager setup, build task updates, other changes (e.g., .gitignore)
Comment	Add or modify comments
Rename	Rename or move files/folders
Remove	Delete a file
!BREAKING CHANGE	Major API change
!HOTFIX	Critical bug fix in urgency

📌 Pull Request Convention

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
⏪	:rewind	Revert changes
🔀	:twisted_rightwards_arrows	Merge branches
💡	:bulb	Add/modify comments
🗃	:card_file_box	Database-related changes

📌 Branch Naming Convention

Branch Name	Description
main	Main branch
dev	Development branch
feature/#	Feature branch
fix/#	Bug fix branch
hotfix/#	Critical bug fix branch
release/#	Release branch

👥 Team Member

name	email	major
박민기	https://github.com/mingi_jeok	Computer Science Engineering
조원준	https://github.com/jun6292	Computer Science Engineering