Skip to content

[Docs] 작업 전 관련 이슈 확인 규칙 정리 #62

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
learncold merged 1 commit into from
Apr 2, 2026
Merged

[Docs] 작업 전 관련 이슈 확인 규칙 정리 #62

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,9 @@

## GitHub Workflow
- Use GitHub issue forms for new work items; blank issues are disabled.
- Before starting work, check whether a related GitHub issue already exists.
- 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.
- If the work falls under the existing docs/policy-only exception, it may proceed without opening a separate issue.
- Issue types currently supported:
- `Epic` for larger parent work
- `Implementation Task` for `Engine` / `Domain` / `Application` / `Build` work
Expand Down
3 changes: 3 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,8 @@ PR은 작은 단위로 나누고, 기본적으로 어떤 issue를 해결하는
## 기본 원칙

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

- 새 work item은 GitHub issue form으로 생성합니다.
- 새 issue를 만들 때는 한국어로 작성합니다.
- `Epic`은 여러 task를 묶는 상위 계획에 사용합니다.
- `Implementation Task`는 `Engine`, `Domain`, `Application`, `Build` 같은 코드/빌드 작업에 사용합니다.
- `Lightweight Task`는 `Docs`, `Chore`, `Analysis` 같은 작은 작업에 사용합니다.
Expand Down
2 changes: 2 additions & 0 deletions docs/GitHub Project.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -59,6 +59,8 @@
- Task: `#31 ~ #35` (`Task-...` 형식)

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