From 122702a850876bd2a207d906d05112385f33a0eb Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E1=84=87=E1=85=A1=E1=86=A8=E1=84=80=E1=85=A7=E1=86=BC?= =?UTF-8?q?=E1=84=90=E1=85=A2?= Date: Wed, 30 Apr 2025 16:18:50 +0900 Subject: [PATCH] docs: add branch_guidelines.md --- docs/branch_guidelines.md | 52 +++++++++++++++++++++++++++++++++++++++ 1 file changed, 52 insertions(+) create mode 100644 docs/branch_guidelines.md diff --git a/docs/branch_guidelines.md b/docs/branch_guidelines.md new file mode 100644 index 0000000..202a393 --- /dev/null +++ b/docs/branch_guidelines.md @@ -0,0 +1,52 @@ +# Branch Guidelines + +## 개요 + +이 문서는 이 프로젝트에서의 브랜치 전략과 작업 방식에 대해 설명합니다. +새로운 기여자가 쉽게 이해하고 따를 수 있도록, 실제 작업 예시와 함께 브랜치 사용 규칙을 문서화합니다. + +## 브랜치 네이밍 규칙 + +- 브랜치 이름 형식: `feature/이슈번호-작업내용` + - 예시: `feature/32-branch-guidelines` + +## 작업 절차 예시 + +1. **문제점 발견** + - 작업이 필요한 버그나 개선 사항 등을 발견합니다. + +2. **이슈 생성** + - GitHub 또는 이슈 트래커에 이슈를 등록합니다. + - 이슈 템플릿: + + ``` + - Why❓ : 이 작업이 필요한 이유 + - How❓ : 해결 방법 또는 접근 방식 + - What❓ : 작업해야 할 구체적인 내용 + ``` + +3. **master 브랜치 최신화** + - 로컬 환경에서 `master` 브랜치를 최신 상태로 유지합니다. + +4. **작업 브랜치 생성** + - 위의 네이밍 규칙에 따라 새로운 브랜치를 생성합니다. + - 예시: `feature/32-branch-guidelines` + +5. **작업 수행** + - 필요한 기능 구현 또는 코드 수정을 진행합니다. + +6. **Pull Request(PR) 생성** + - 작업이 완료되면 `master` 브랜치 대상으로 PR을 생성합니다. + - PR 제목과 설명에는 이슈 번호를 명시합니다. + +7. **리뷰 요청** + - 최소 2명의 팀원에게 코드 리뷰를 요청합니다. + +8. **병합(Merge)** + - 리뷰 승인을 받은 후 `master` 브랜치에 병합합니다. + +## 참고 사항 + +- 가능하면 커밋 메시지도 의미 있게 작성해주세요. +- 필요 시 `hotfix/`, `bugfix/`, `refactor/` 등 브랜치 접두어를 추가로 사용할 수 있습니다. +- PR에는 작업 목적, 변경 내용, 테스트 방법 등을 명확히 기술해주세요.