10 KiB
Code Review Reference - API
[IMPLEMENTING AGENT — READ FIRST] Filling in this file is the mandatory final step of implementation. The task is NOT complete until every implementation-owned section below is filled in. Complete the
구현 체크리스트; the final checklist item is mandatory before saving. Fill implementation-owned sections, then stop with active files in place and report ready for review. If implementation is blocked by a user-only decision, user-owned external environment prerequisite, or scope conflict, fill사용자 리뷰 요청with evidence and stop with active files in place; code-review decides whether to writeUSER_REVIEW.md. Evidence gaps that a follow-up agent can close by rerunning commands or collecting artifacts are normal follow-up issues, not user-review blockers by themselves. Finalization (코드리뷰 결과, log rename,complete.log, archive moves,코드리뷰 전용 체크리스트) is review-agent-only, even after compaction/resume. Follow the ownership table at the bottom of this file for which sections you own.
개요
date=2026-05-30 task=m-messaging-contract, plan=0, tag=API
Roadmap Targets
- Milestone:
agent-roadmap/phase/messaging-runtime/milestones/messaging-contract.md - Task ids:
event-shape: notification event, opened event, token event의 payload shape와 backward compatibility 기준을 문서화한다.token-flow: device token 저장, auth token 저장, signing key 저장 책임과 호출 순서를 정리한다.sdk-runtime-boundary: Flutter SDK가 server/push contract를 추적하되 Mattermost mobile implementation을 팔로잉하지 않는 경계를 문서화한다.
- Completion mode: check-on-pass
이 파일을 읽는 리뷰 에이전트에게
[REVIEW AGENT ONLY] 아래 종결 절차는 코드리뷰 에이전트 전용이다. 구현 에이전트는 이 섹션을 실행하지 않는다.
각 항목의 구현을 실제 소스 파일과 대조하고, 검증 결과 섹션의 출력이 코드와 일치하는지 확인하세요.
리뷰 완료는 아래 순서까지 끝난 상태를 의미합니다.
- 판정을 append한다.
CODE_REVIEW-cloud-G06.md→code_review_cloud_G06_N.log,PLAN-cloud-G06.md→plan_cloud_G06_M.log로 아카이브한다.- PASS이면
complete.log작성 후 active task 디렉터리를agent-task/archive/YYYY/MM/m-messaging-contract/로 이동한다. WARN/FAIL이면 user-review gate를 확인한 뒤 다음 active plan/review 파일 또는USER_REVIEW.md를 작성한다.USER_REVIEW.md가 사용자 결정으로 완료/PASS 해소되면 code-review가USER_REVIEW.md를 해소 상태로 갱신하고complete.log작성 후 archive 이동한다. - PASS이고 task group이
m-<milestone-slug>이면 완료 이벤트 메타데이터를 보고한다. roadmap 상태 체크와update-roadmap호출은 런타임 책임이다. - 적용 가능한
코드리뷰 전용 체크리스트항목을 최종.log위치에서 체크한 뒤 보고한다.
구현 항목별 완료 여부
| 항목 | 완료 여부 |
|---|---|
| [API-1] Event Shape Contract | [ ] |
| [API-2] Token And Credential Flow | [ ] |
| [API-3] Runtime Tracking Boundary | [ ] |
구현 체크리스트
- README에 Event Shape Contract를 추가하고 notification/opened/token event payload shape와 backward compatibility 기준을 문서화한다.
- README에 Token and Credential Flow를 추가하고 device token, auth token, signing key 저장 책임과 호출 순서를 정리한다.
- README에 Runtime Tracking Boundary를 보강하고 Flutter SDK가 server/push contract를 추적하되 Mattermost mobile implementation을 팔로잉하지 않는 경계를 문서화한다.
- 최종 static verification 명령을 실행하고 출력 전체를
CODE_REVIEW-cloud-G06.md에 기록한다. - CODE_REVIEW-*-G??.md의 구현 에이전트 소유 섹션을 실제 구현 내용과 검증 출력으로 채운다. 이 항목이 완료되기 전에는 구현이 완료된 것이 아니다.
코드리뷰 전용 체크리스트
[REVIEW AGENT ONLY] 이 체크리스트는 코드리뷰 에이전트만 사용한다. 구현 에이전트는 이 섹션을 수정하거나 체크하지 않는다.
코드리뷰 결과에PASS,WARN,FAIL중 하나의 판정을 append한다.- 판정과
차원별 평가, Required/Suggested/Nit 분류가 서로 일치한다. - active
CODE_REVIEW-*-G??.md를code_review_cloud_G06_N.log로 아카이브한다. - active
PLAN-*-G??.md를plan_cloud_G06_M.log로 아카이브한다. - PASS이면
agent-ops/skills/common/code-review/templates/complete-log-template.md기준으로complete.log를 작성하고 active.md파일을 남기지 않는다. - PASS이면 active task 디렉터리
agent-task/m-messaging-contract/를agent-task/archive/YYYY/MM/m-messaging-contract/로 이동하고 최종 archive 경로에서 이 체크리스트를 갱신한다. - PASS이고 task group이
m-<milestone-slug>이면 런타임이 읽을 완료 이벤트 메타데이터를 보고하고, roadmap 수정이나update-roadmap직접 호출을 하지 않는다. - PASS split 작업이면 이동 후 빈 active parent
agent-task/m-messaging-contract/를 제거하거나, 남은 sibling/file이 있어 유지했다고 확인한다. - WARN/FAIL이고 user-review gate가 트리거되지 않았으면 다음 active
PLAN-cloud-G06.md와CODE_REVIEW-cloud-G06.md를 작성하고complete.log를 작성하지 않는다. - USER_REVIEW이면
agent-ops/skills/common/code-review/templates/user-review-template.md기준으로USER_REVIEW.md를 작성하고 activePLAN-*.md,CODE_REVIEW-*.md,complete.log를 남기지 않는다. - USER_REVIEW가 사용자 결정으로 완료/PASS 해소되면
USER_REVIEW.md를 해소 상태로 갱신하고complete.log를 작성한 뒤 task directory를 archive로 이동한다.
계획 대비 변경 사항
구현 에이전트가 계획과 다르게 구현한 부분을 이유와 함께 기록한다.
주요 설계 결정
구현 에이전트가 주요 설계 결정 사항을 기록한다.
사용자 리뷰 요청
기본값은 없음이다. 구현 중 사용자 결정, 사용자 소유 외부 환경/secret/서비스 준비, 또는 계획 범위 변경 없이는 안전하게 진행할 수 없으면 아래 항목을 실제 내용으로 교체하고, 구현을 중단한 뒤 active 파일을 그대로 둔 채 리뷰를 요청한다. 후속 에이전트가 명령 재실행이나 산출물 수집으로 해소할 수 있는 검증 증거 공백만으로는 사용자 리뷰 요청을 작성하지 않는다.
- 상태: 없음
- 사유 유형: 없음
- 결정 필요: 없음
- 차단 근거: 없음
- 실행한 검증/명령: 없음
- 자동 후속 불가 이유: 없음
- 재개 조건: 없음
리뷰어를 위한 체크포인트
- README의 event shape가 Dart parsing과 Android event emission behavior를 과장하지 않는지 확인한다.
- token/auth/signing key 흐름이 현재 native implementation과 맞고 secret 값을 문서에 남기지 않았는지 확인한다.
- runtime boundary가 Mattermost mobile implementation을 추적 대상으로 오해하게 만들지 않는지 확인한다.
검증 결과
구현 에이전트가 각 중간 검증 및 최종 검증 명령 실행 후 출력을 여기에 붙여 넣는다.
필수 규칙:
- 검증 명령은 고정된 계약이다. 임의로 대체하지 않는다.
- 대체가 필요하면
계획 대비 변경 사항에 이유와 대체 명령을 기록한다. 검증 결과에는 실제 stdout/stderr를 붙여 넣는다.- 사용자 리뷰 요청으로 명령을 끝까지 실행하지 못했다면
사용자 리뷰 요청에 실행한 명령, 실제 출력, 미실행 명령의 사유를 기록한다.
API-1 중간 검증
$ rg --sort path "Event Shape Contract|userInteraction|token_refresh|is_crt_enabled" packages/messaging_flutter/README.md
(output)
API-2 중간 검증
$ rg --sort path "Token And Credential Flow|android_rn-v2|setAuthToken|setSigningKey|saveDeviceToken|clearAuthToken" packages/messaging_flutter/README.md
(output)
API-3 중간 검증
$ rg --sort path "Runtime Tracking Boundary|server/push contract|Mattermost mobile|React Native|typed" packages/messaging_flutter/README.md
(output)
최종 검증
$ git diff --check
(output)
$ rg --sort path "Event Shape Contract|Token And Credential Flow|Runtime Tracking Boundary" packages/messaging_flutter/README.md
(output)
[IMPLEMENTING AGENT — BEFORE SAVING] Have you filled in every implementation-owned section: completion table, implementation checklist, changes from plan, design decisions, and verification output? If anything is blank, go back and fill it in before saving this file. Leave review-agent-only sections unchanged.
Ownership
| Section | Owner | Note |
|---|---|---|
| Header comment, 개요, 리뷰 에이전트 지시 | Fixed at stub creation | Implementing agent must not modify or execute these (archive, complete.log, and task-directory archive move are review-agent only) |
| Roadmap Targets | Fixed at stub creation from plan when present | Implementing agent must not modify; code-review copies it into complete.log as Roadmap Completion only on PASS |
| 구현 항목별 완료 여부 (item names) | Fixed at stub creation | Implementing agent checks [ ] → [x] only |
| 구현 체크리스트 (item text/order) | Fixed at stub creation from plan | Implementing agent checks [ ] → [x] only; final checkbox is mandatory before saving |
| 코드리뷰 전용 체크리스트 | Review agent only | Implementing agent must not modify or check this section |
| 계획 대비 변경 사항, 주요 설계 결정 | Implementing agent | Replace placeholder text with actual content |
| 사용자 리뷰 요청 | Implementing agent | Keep 상태: 없음 unless user input is required to proceed; when filled, include exact decision, evidence, commands/output, why automatic follow-up cannot resolve it, and resume condition |
| 리뷰어를 위한 체크포인트 | Fixed at stub creation | Pre-filled from plan |
| 검증 결과 (section headings + commands) | Fixed at stub creation | Implementing agent fills in command output only; command changes require a 계획 대비 변경 사항 entry |
| 코드리뷰 결과 | Review agent appends | Not included in stub |