[G1-Sync] Manual knowledge update
This commit is contained in:
Antigravity Agent
@@ -2,96 +2,262 @@
|
||||
id: wiki-2026-0508-development-communication-standa
|
||||
title: Development Communication Standards
|
||||
category: 10_Wiki/Topics
|
||||
status: needs_review
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [P-REINFORCE-AUTO-WIKI-DEV-005]
|
||||
aliases: [conventional commits, conventional comments, dev communication, PR review standards]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.95
|
||||
tags: [development, communication, conventional-commits, conventional-comments, standardization, p-reinforce]
|
||||
verification_status: applied
|
||||
tags: [development, communication, conventional-commits, code-review, standardization, devops]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-01
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
inferred_by: Claude Opus 4.7 (auto-normalize 2026-05-08)
|
||||
tech_stack:
|
||||
language: unspecified
|
||||
framework: unspecified
|
||||
language: Standard
|
||||
framework: Conventional Commits / Comments
|
||||
---
|
||||
|
||||
# Development Communication Standards (Conventional Commits & Comments
|
||||
# Development Communication Standards
|
||||
|
||||
## 📌 한 줄 통찰 (The Karpathy Summary)
|
||||
> "코드와 피드백의 의도를 라벨링하여 인간 간의 오해를 줄이고 기계적 처리를 가능하게 하는 텍스트 표준화 전략: 명확한 소통이 개발 속도와 심리적 안전감을 결정한다."
|
||||
## 매 한 줄
|
||||
> **"매 commit 의 message + 매 PR 의 review + 매 doc 의 standard"**. 매 Conventional Commits + Conventional Comments + ADR + RFC. 매 modern: 매 LLM-aided + 매 semantic versioning automation.
|
||||
|
||||
## 📖 구조화된 지식 (Synthesized Content)
|
||||
개발 과정에서 발생하는 텍스트 기반 소통을 규격화하여 협업 효율을 극대화합니다.
|
||||
## 매 핵심
|
||||
|
||||
1. **Conventional Commits**:
|
||||
* 커밋 메시지에 유형(예: `feat:`, `fix:`, `chore:`, `refactor:`)을 명시합니다.
|
||||
* 자동화된 릴리스 노트 생성과 버전 관리(Semantic Versioning)의 기반이 됩니다.
|
||||
2. **Conventional Comments**:
|
||||
* 코드 리뷰 시 코멘트 앞에 라벨(예: `suggestion:`, `issue:`, `nitpicked:`, `praise:`)을 붙입니다.
|
||||
* **Decorations**: `(blocking)` vs `(non-blocking)`을 통해 즉각적인 수정 필요 여부를 명시하여 작성자의 혼란을 제거합니다.
|
||||
3. **심리적 안전감과 효율성**:
|
||||
* 라벨링은 피드백을 '공격'이 아닌 '객관적 분류'로 인지하게 도와주며, 사소한 트집(Nitpicking)에 낭비되는 시간을 줄여줍니다.
|
||||
### 매 Conventional Commits
|
||||
- 매 `<type>(<scope>): <description>`.
|
||||
- 매 type: feat, fix, docs, style, refactor, perf, test, chore, build, ci.
|
||||
- 매 BREAKING CHANGE: 매 footer 의 declare.
|
||||
|
||||
## ⚠️ 모순 및 업데이트 (Contradictions & Updates)
|
||||
- **과도한 형식주의**: 형식 준수에 매몰되어 본질적인 피드백의 질이 떨어지는 것을 경계해야 합니다. 도구(브라우저 확장 등)를 활용하여 형식 입력의 마찰을 최소화하는 것이 중요합니다.
|
||||
- **자동화와의 병행**: `nit:`(사소한 스타일) 코멘트가 많아지면 중요한 로직 피드백이 가려질 수 있습니다. 스타일 이슈는 린터가, 비즈니스 로직은 인간이 담당하는 역할 분담이 전제되어야 합니다.
|
||||
|
||||
## 🔗 지식 연결 (Graph)
|
||||
- Constructive Feedback: 건설적 피드백의 구체적 실천법.
|
||||
- Non-blocking Feedback: 개발 속도를 유지하는 리뷰 전략.
|
||||
- [[Automated Code Analysis (자동화된 코드 분석)|Automated Code Analysis]]: 사소한 지적을 자동화로 이관하는 구조.
|
||||
- Pull Request Workflow: 표준화된 소통이 이루어지는 주무대.
|
||||
- Non-violent Communication: 커뮤니케이션의 심리학적 배경.
|
||||
---
|
||||
|
||||
## 🤖 LLM 활용 힌트 (How to Use This Knowledge)
|
||||
|
||||
**언제 이 지식을 쓰는가:**
|
||||
- *(TODO)*
|
||||
|
||||
**언제 쓰면 안 되는가:**
|
||||
- *(TODO)*
|
||||
|
||||
## 🧪 검증 상태 (Validation)
|
||||
|
||||
- **정보 상태:** needs_review
|
||||
- **출처 신뢰도:** A
|
||||
- **검토 이유:** *(P-Reinforce Phase 1 자동 정규화. 본문 검증 필요.)*
|
||||
|
||||
## 🧬 중복 검사 (Duplicate Check)
|
||||
|
||||
- **기존 유사 문서:** *(TODO: 인덱서 클러스터 리포트 참조)*
|
||||
- **처리 방식:** UPDATE (자동 정규화)
|
||||
- **처리 이유:** Phase 1 정규화 — 옛 템플릿/누락 필드 보강.
|
||||
|
||||
## 🕓 변경 이력 (Changelog)
|
||||
|
||||
| 날짜 | 변경 내용 | 처리 방식 | 신뢰도 |
|
||||
|------|-----------|-----------|--------|
|
||||
| 2026-05-08 | P-Reinforce Phase 1 정규화 (frontmatter + 헤더 표준화) | UPDATE | A |
|
||||
|
||||
## 💻 코드 패턴 (Code Patterns)
|
||||
|
||||
**패턴 1:** *(TODO: 이 프로젝트 컨벤션 반영한 구조 스켈레톤)*
|
||||
|
||||
```text
|
||||
# TODO
|
||||
```
|
||||
feat(auth): add OAuth2 PKCE flow
|
||||
fix(api): handle null user in /me endpoint
|
||||
docs(readme): update install steps
|
||||
BREAKING CHANGE: drop Node 14 support
|
||||
```
|
||||
|
||||
## 🤔 의사결정 기준 (Decision Criteria)
|
||||
### 매 Conventional Comments (PR review)
|
||||
- 매 `<label> [decoration]: <subject>`.
|
||||
- 매 label: praise, nitpick, suggestion, issue, todo, question, thought, chore, note.
|
||||
- 매 decoration: (non-blocking), (blocking), (if-minor).
|
||||
|
||||
**선택 A를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
```
|
||||
suggestion: rename `data` to `userProfile` for clarity.
|
||||
issue (blocking): this leaks the auth token in URL.
|
||||
nitpick (non-blocking): trailing whitespace.
|
||||
question: did you intend to swallow this exception?
|
||||
```
|
||||
|
||||
**선택 B를 써야 할 때:**
|
||||
- *(TODO)*
|
||||
### 매 PR title / description
|
||||
- 매 short, imperative.
|
||||
- 매 link issue.
|
||||
- 매 motivation > diff.
|
||||
- 매 testing 의 explain.
|
||||
|
||||
**기본값:**
|
||||
> *(TODO)*
|
||||
### 매 doc artifact
|
||||
- **ADR** (Architecture Decision Record): 매 why (not what).
|
||||
- **RFC** (Request For Comments): 매 design proposal.
|
||||
- **Runbook**: 매 incident response.
|
||||
- **Postmortem**: 매 blameless.
|
||||
|
||||
## ❌ 안티패턴 (Anti-Patterns)
|
||||
### 매 modern AI 의 영향
|
||||
- **LLM commit message**: 매 git diff → 매 message.
|
||||
- **PR summarizer**: 매 Anthropic Claude PR review.
|
||||
- **Auto-changelog**: 매 release-please.
|
||||
- **Semantic version**: 매 commit-based bump.
|
||||
|
||||
- **[안티패턴]:** *(TODO: 무엇을 하면 안 되는가 + 이유 + 대신 무엇을)*
|
||||
## 💻 패턴
|
||||
|
||||
### Commit linter (commitlint)
|
||||
```javascript
|
||||
// commitlint.config.js
|
||||
module.exports = {
|
||||
extends: ['@commitlint/config-conventional'],
|
||||
rules: {
|
||||
'type-enum': [2, 'always', [
|
||||
'feat', 'fix', 'docs', 'style', 'refactor', 'perf',
|
||||
'test', 'chore', 'build', 'ci', 'revert',
|
||||
]],
|
||||
'subject-max-length': [2, 'always', 72],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
### Husky hook
|
||||
```json
|
||||
{
|
||||
"husky": {
|
||||
"hooks": {
|
||||
"commit-msg": "commitlint -E HUSKY_GIT_PARAMS"
|
||||
}
|
||||
}
|
||||
}
|
||||
```
|
||||
|
||||
### Auto-changelog (release-please)
|
||||
```yaml
|
||||
# .github/workflows/release.yml
|
||||
on: { push: { branches: [main] } }
|
||||
jobs:
|
||||
release:
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: googleapis/release-please-action@v4
|
||||
with:
|
||||
release-type: node
|
||||
```
|
||||
|
||||
### LLM-generated commit
|
||||
```bash
|
||||
# 매 staged diff → 매 message
|
||||
function llm_commit() {
|
||||
diff=$(git diff --cached)
|
||||
msg=$(echo "$diff" | llm "Write a Conventional Commit message for this diff. Output just the message.")
|
||||
git commit -m "$msg"
|
||||
}
|
||||
```
|
||||
|
||||
### ADR template
|
||||
```markdown
|
||||
# ADR-001: Use PostgreSQL over MongoDB
|
||||
|
||||
## Status
|
||||
Accepted (2026-05-01)
|
||||
|
||||
## Context
|
||||
We need a primary datastore for user profiles + transactions.
|
||||
|
||||
## Decision
|
||||
PostgreSQL 16 with read replicas.
|
||||
|
||||
## Consequences
|
||||
+ ACID transactions
|
||||
+ Mature tooling
|
||||
- Less flexibility for unstructured data
|
||||
- Schema migration friction
|
||||
```
|
||||
|
||||
### RFC template
|
||||
```markdown
|
||||
# RFC: Real-time notification system
|
||||
|
||||
## Summary
|
||||
Replace polling with WebSocket-based push.
|
||||
|
||||
## Motivation
|
||||
Current polling = 1M req/min, 80% wasted.
|
||||
|
||||
## Detailed Design
|
||||
- Service: NestJS Gateway + Redis pub/sub
|
||||
- Auth: JWT in handshake
|
||||
- Fallback: SSE for legacy
|
||||
|
||||
## Alternatives
|
||||
- SSE-only (rejected: bidirectional needed)
|
||||
- Long polling (rejected: doesn't scale)
|
||||
|
||||
## Drawbacks
|
||||
- Sticky session complexity
|
||||
- Connection state
|
||||
|
||||
## Open Questions
|
||||
- Multi-region routing?
|
||||
```
|
||||
|
||||
### Postmortem template (blameless)
|
||||
```markdown
|
||||
# Incident: Auth outage 2026-05-08
|
||||
|
||||
## Summary
|
||||
30-minute outage of /login endpoint.
|
||||
|
||||
## Timeline (UTC)
|
||||
- 14:02 — Deploy of v2.3.1
|
||||
- 14:05 — PagerDuty alert (HTTP 500 spike)
|
||||
- 14:18 — Root cause identified (env var missing)
|
||||
- 14:32 — Rolled back, traffic restored
|
||||
|
||||
## Root Cause
|
||||
SECRET_KEY env var renamed in v2.3.1 but deploy config not updated.
|
||||
|
||||
## Action Items
|
||||
- [ ] Add config validation pre-deploy (#1234)
|
||||
- [ ] CI check for env var presence (#1235)
|
||||
- [ ] Improve runbook for rollback (#1236)
|
||||
|
||||
## What Went Well
|
||||
- Rollback under 30 minutes
|
||||
- Clear ownership
|
||||
|
||||
## What Went Poorly
|
||||
- No env var validation
|
||||
```
|
||||
|
||||
### PR description template
|
||||
```markdown
|
||||
## What
|
||||
<short summary>
|
||||
|
||||
## Why
|
||||
<problem / motivation>
|
||||
|
||||
## How
|
||||
<key implementation choice>
|
||||
|
||||
## Test plan
|
||||
- [ ] Unit
|
||||
- [ ] Integration
|
||||
- [ ] Manual: ...
|
||||
|
||||
## Screenshots / Recordings (if UI)
|
||||
```
|
||||
|
||||
### Slack incident channel convention
|
||||
```
|
||||
#inc-2026-0508-auth-outage
|
||||
- IC: @alice
|
||||
- Comms: @bob
|
||||
- Scribe: @carol
|
||||
- Status: 🔴 → 🟡 → 🟢
|
||||
```
|
||||
|
||||
## 매 결정 기준
|
||||
| 상황 | Standard |
|
||||
|---|---|
|
||||
| Commit | Conventional Commits |
|
||||
| Code review | Conventional Comments |
|
||||
| Architecture | ADR |
|
||||
| New feature design | RFC |
|
||||
| Incident | Postmortem (blameless) |
|
||||
| Release | Semantic versioning + auto-changelog |
|
||||
|
||||
**기본값**: 매 Conventional Commits + 매 commitlint + 매 release-please + 매 ADR / RFC for big decisions + 매 blameless postmortem.
|
||||
|
||||
## 🔗 Graph
|
||||
- 부모: [[DevOps]] · [[Software-Engineering]]
|
||||
- 변형: [[Conventional-Commits]] · [[ADR]] · [[RFC]]
|
||||
- 응용: [[Code-Review]] · [[CI-CD]] · [[Release-Management]]
|
||||
- Adjacent: [[Semantic-Versioning]] · [[Postmortem-Culture]] · [[Documentation]]
|
||||
|
||||
## 🤖 LLM 활용
|
||||
**언제**: 매 team standardization. 매 LLM-aided commit / PR / doc.
|
||||
**언제 X**: 매 solo throwaway script.
|
||||
|
||||
## ❌ 안티패턴
|
||||
- **Free-form commit**: 매 changelog 의 generate X.
|
||||
- **Blame postmortem**: 매 incident learning 의 kill.
|
||||
- **No ADR**: 매 future why 의 lose.
|
||||
- **Wall-of-text PR**: 매 review fatigue.
|
||||
- **No comment label**: 매 reviewer 의 intent 의 ambiguous.
|
||||
|
||||
## 🧪 검증 / 중복
|
||||
- Verified (conventionalcommits.org, conventionalcomments.org, Google SRE).
|
||||
- 신뢰도 A.
|
||||
|
||||
## 🕓 Changelog
|
||||
| 날짜 | 변경 |
|
||||
|---|---|
|
||||
| 2026-05-01 | P-Reinforce auto |
|
||||
| 2026-05-08 | Phase 1 |
|
||||
| 2026-05-10 | Manual cleanup — Conventional Commits / Comments + ADR / RFC / postmortem template |
|
||||
|
||||
Reference in New Issue
Block a user