Project Git Convention

github convention

• Whenever someone starts to change a code or setting, create a new issue and checkout new branch from main branch.
• branch names & commit messages should include the issue number in it.
• one or more teammates should review the Pull Request to merge to main branch.
• As soon as any crash or merge conflict occurs, report it on slack immediately so that other teammates are aware of the issue.

Commit message convention

type(scope) #issue : subject

feat(backend) #3 : add refresh token endpoint

Branch convention

scope/type/issue#-detail

fe/feat/14-feed-screen

type

feat

• Used for commits that new feature update

• feat(backend) #3 : add refresh token endpoint
• feat(frontend) #1 : main page added

fix

• Used for commits that patch a bug or correct an error

• fix(backend) #139 : correct JWT expiration validation
• fix(frontend) #71 : fix main page pagination error

refactor

• Used for commits that restructure code without changing its behavior.

• refactor(backend) #14 : restructure auth service
• refactor(frontend) #94 : separate utility functions to new file

chore

• Used for commits related to maintenance, tooling, or development environment updates

• chore(backend) #15 : update Spring Boot to 3.3.0
• chore(frontend) #16 : update all package dependencies to latest

docs

• Used for commits that change or update documentation files

• docs(backend) #18 : update API spec for user login
• docs(common) #24 : update README.md

scope

• frontend
• backend
• common

issue

• issue number of the github/issues tab