Skip to content

Commit 047ec02

Browse files
authored
docs: 작업 전 관련 이슈 확인 규칙 추가 (#62)
1 parent 3770cbe commit 047ec02

3 files changed

Lines changed: 8 additions & 0 deletions

File tree

AGENTS.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,9 @@
5959

6060
## GitHub Workflow
6161
- Use GitHub issue forms for new work items; blank issues are disabled.
62+
- Before starting work, check whether a related GitHub issue already exists.
63+
- If no related issue exists and the current policy does not exempt the work from issue creation, open a new issue in Korean first and then start the implementation.
64+
- If the work falls under the existing docs/policy-only exception, it may proceed without opening a separate issue.
6265
- Issue types currently supported:
6366
- `Epic` for larger parent work
6467
- `Implementation Task` for `Engine` / `Domain` / `Application` / `Build` work

CONTRIBUTING.md

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -6,6 +6,8 @@ PR은 작은 단위로 나누고, 기본적으로 어떤 issue를 해결하는
66
## 기본 원칙
77

88
- 기본 작업 흐름은 `issue -> branch -> PR -> merge`입니다.
9+
- 작업을 시작하기 전에 먼저 관련 GitHub issue가 이미 있는지 확인합니다.
10+
- 관련 issue가 없고 현재 정책상 issue 생성을 생략할 수 없는 작업이면, 새 issue를 한글로 등록한 뒤 작업을 시작합니다.
911
- 다만 `docs/`, `uml/`, `CONTRIBUTING.md`, PR/issue template, PR 정책 워크플로처럼 문서 또는 기여 정책만 다루는 변경은 별도 issue 없이 진행할 수 있습니다.
1012
- 위 예외에 해당하는 변경이 해당 경로에만 한정된다면 유지보수자는 `main`에 직접 commit/push할 수 있습니다.
1113
- 문서/정책 변경과 코드/빌드 변경이 섞이면 예외를 쓰지 않고 일반 PR 흐름으로 진행합니다.
@@ -16,6 +18,7 @@ PR은 작은 단위로 나누고, 기본적으로 어떤 issue를 해결하는
1618
## Issue Rules
1719

1820
- 새 work item은 GitHub issue form으로 생성합니다.
21+
- 새 issue를 만들 때는 한국어로 작성합니다.
1922
- `Epic`은 여러 task를 묶는 상위 계획에 사용합니다.
2023
- `Implementation Task``Engine`, `Domain`, `Application`, `Build` 같은 코드/빌드 작업에 사용합니다.
2124
- `Lightweight Task``Docs`, `Chore`, `Analysis` 같은 작은 작업에 사용합니다.

docs/GitHub Project.md

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -59,6 +59,8 @@
5959
- Task: `#31 ~ #35` (`Task-...` 형식)
6060

6161
## 메모
62+
- 작업을 시작하기 전에 먼저 관련 issue가 이미 있는지 확인한다.
63+
- 관련 issue가 없고 docs/policy-only 예외가 아닌 작업이면, 적절한 issue form으로 한국어 issue를 먼저 만든 뒤 branch 작업으로 들어간다.
6264
- `Docs`, `Chore`, `Analysis``Lightweight Task` form으로 가볍게 등록한다.
6365
- `Engine`, `Domain`, `Application`, `Build``Implementation Task` form으로 범위와 검증 계획까지 남긴다.
6466
- 현재 Project 보드의 `Area` 필드에는 `Build` 옵션이 없으므로, Build 성격 task는 issue form과 본문에는 `Build`로 남기고 보드에서는 임시로 가장 가까운 기존 영역에 배치한다.

0 commit comments

Comments
 (0)