GitHub Convention

Commit Message Example

git config --global commit.template .gitmessage


# <type>(<scope>): <subject>
##### Subject 50 characters ################# -> |

# Body Message
######## Body 72 characters ####################################### -> |

# Issue Tracker Number or URL

# --- COMMIT END ---
# Type can be
#   feat    : new feature
#   fix     : bug fix
#   perf    : performance improvement
#   build   : dependency or build system change
#   ci      : CI configuration and scripts
#   refactor: refactoring production code
#   style   : formatting, missing semi colons, etc; no code change
#   docs    : changes to documentation
#   test    : adding or refactoring tests; no production code change
#   chore   : updating grunt tasks etc; no production code change
# ------------------
# Remember me ~
#   Capitalize the subject line
#   Use the imperative mood in the subject line
#   Do not end the subject line with a period
#   Separate subject from body with a blank line
#   Use the body to explain what and why vs. how
#   Can use multiple lines with "-" for bullet points in body
# ------------------

Branching Rule

Gitflow

Branch Name

A Simplified Convention for Naming Branches and Commits in Git

유형/내용으로 함

유형: feature(기능 추가), bugfix(오류 수정), hotfix(급한 오류 수정), test(이슈가 아닌 실험성 작업)
내용: 단위는 Notion 칸반보드 하나, 즉 Issue 하나로 함

예시) feature/input, feature/gantt, fix/fcfs

Pull Request Rule (코드리뷰 관련)

Pull Request 하는 법

[Github] Pull Request를 통해 코드리뷰(Code Review)하는 법

한 Issue에 대한 기능 구현 및 수정이 완료되었을 경우 해당 branch를 push
github에서 main branch로 pull request 생성. reviewer로 팀원 한 명이상을 등록
모든 reviewer는 Files Changed 탭에서 코드를 검토하고 승인한다면 Approve 클릭