docs(10_Wiki): 위키 전체 재구성 — Topic_* 폴더를 4개 카테고리로 통합 + 대규모 중복 제거
Topic_Agent/Topic_Blog/Topics/Topics_Biz/Topics_Meeting/Topics_Rag의 마크다운 지식 문서를 Topic_General/Topic_Programming/Topic_Graphic/Topic_Business 4개 카테고리로 재분류. - 중복 제거: frontmatter의 status:duplicate/merged + duplicate_of/redirect_to 필드로 자기 자신을 중복으로 선언한 리다이렉트 stub 1032개 제거, 완전 동일 내용 파일 472개 제거, 동일 파일명·다른 내용 충돌 시 더 큰(완전한) 버전만 유지(162개 제거) — 총 1639개 중복 제거. - 분류: 폴더 단위로 명확한 항목(AI_and_ML/Coding/Architecture 등 → Programming, Comfyui/Visual_Effects → Graphic, Topics_Biz/Topics_Meeting/사업 등 → Business, Poetic_Blog_Writing/창의성/Game_Design 등 → General)은 폴더 우선순위로, 나머지 혼재 폴더(Topic_Agent/Topic_Blog/Topics 루트/Thinking & Reasoning/Other/UI_UX_Assets)는 title/tags 키워드 스코어링으로 파일 단위 분류(불명확한 경우 General로 폴백). 원본 폴더명은 "From_*" 서브폴더로 보존해 추적 가능성 유지. - 최종 배치: Programming 2784 / General 1608 / Graphic 285 / Business 249 = 4926개 문서. - 에이전트 운영 상태(.astra/.agent/.obsidian/sessions/memory/_company/docs/lessons/_shared/src)는 지식 콘텐츠가 아니므로 재분류 대상에서 제외하고 원위치 유지. - Topics/Topic_email(상위 보호 폴더 Topic_email과 파일명 100% 중복) 삭제 — 보호 폴더 자체는 미변경. - 완전히 비게 된 Topic_Agent/Topic_Blog/Topics_Biz/Topics_Rag 폴더 제거.
This commit is contained in:
Antigravity Agent
@@ -0,0 +1,263 @@
|
||||
---
|
||||
id: wiki-2026-0508-development-communication-standa
|
||||
title: Development Communication Standards
|
||||
category: 10_Wiki/Topics
|
||||
status: verified
|
||||
canonical_id: self
|
||||
aliases: [conventional commits, conventional comments, dev communication, PR review standards]
|
||||
duplicate_of: none
|
||||
source_trust_level: A
|
||||
confidence_score: 0.95
|
||||
verification_status: applied
|
||||
tags: [development, communication, conventional-commits, code-review, standardization, devops]
|
||||
raw_sources: []
|
||||
last_reinforced: 2026-05-10
|
||||
github_commit: pending
|
||||
tech_stack:
|
||||
language: Standard
|
||||
framework: Conventional Commits / Comments
|
||||
---
|
||||
|
||||
# Development Communication Standards
|
||||
|
||||
## 매 한 줄
|
||||
> **"매 commit 의 message + 매 PR 의 review + 매 doc 의 standard"**. 매 Conventional Commits + Conventional Comments + ADR + RFC. 매 modern: 매 LLM-aided + 매 semantic versioning automation.
|
||||
|
||||
## 매 핵심
|
||||
|
||||
### 매 Conventional Commits
|
||||
- 매 `<type>(<scope>): <description>`.
|
||||
- 매 type: feat, fix, docs, style, refactor, perf, test, chore, build, ci.
|
||||
- 매 BREAKING CHANGE: 매 footer 의 declare.
|
||||
|
||||
```
|
||||
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
|
||||
```
|
||||
|
||||
### 매 Conventional Comments (PR review)
|
||||
- 매 `<label> [decoration]: <subject>`.
|
||||
- 매 label: praise, nitpick, suggestion, issue, todo, question, thought, chore, note.
|
||||
- 매 decoration: (non-blocking), (blocking), (if-minor).
|
||||
|
||||
```
|
||||
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?
|
||||
```
|
||||
|
||||
### 매 PR title / description
|
||||
- 매 short, imperative.
|
||||
- 매 link issue.
|
||||
- 매 motivation > diff.
|
||||
- 매 testing 의 explain.
|
||||
|
||||
### 매 doc artifact
|
||||
- **ADR** (Architecture Decision Record): 매 why (not what).
|
||||
- **RFC** (Request For Comments): 매 design proposal.
|
||||
- **Runbook**: 매 incident response.
|
||||
- **Postmortem**: 매 blameless.
|
||||
|
||||
### 매 modern AI 의 영향
|
||||
- **LLM commit message**: 매 git diff → 매 message.
|
||||
- **PR summarizer**: 매 Anthropic Claude PR review.
|
||||
- **Auto-changelog**: 매 release-please.
|
||||
- **Semantic version**: 매 commit-based bump.
|
||||
|
||||
## 💻 패턴
|
||||
|
||||
### 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]]
|
||||
- 변형: [[Conventional-Commits]] · [[ADR]] · [[RFC]]
|
||||
- 응용: [[Code-Review]] · [[CI CD]]
|
||||
- Adjacent: [[Postmortem-Culture]]
|
||||
|
||||
## 🤖 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