문서 리뷰 가이드라인

좋은 문서는 좋은 리뷰에서 나옵니다. 본 프로젝트는 GitHub Pull Request 를 통해 문서를 리뷰하며, 리뷰 과정 자체를 오픈소스 기여 훈련의 일부로 봅니다.

참고

기여자 작업용 골격입니다. 운영 경험을 바탕으로 체크리스트를 보강해 주세요.

기여자(작성자) 체크리스트

• [ ] 로컬에서 tox -e docs 빌드가 통과하는가

• [ ] tox -e pep8 (doc8) 린트가 통과하는가

• [ ] 새 문서를 상위 toctree 에 등록했는가

• [ ] 교차 참조(:doc:)와 외부 링크가 유효한가

• [ ] 용어를 용어집 와 일관되게 사용했는가

• [ ] 번역 문서라면 원문 출처와 버전을 명시했는가

리뷰어 체크리스트

• 정확성 — 기술적으로 정확한가, outdated 정보(예: Heat 기반 Magnum)는 없는가

• 명확성 — 입문자가 이해할 수 있는가

• 구조 — 적절한 섹션/제목 레벨을 사용했는가

• 일관성 — 용어·표기·스타일이 프로젝트 관례를 따르는가

• 빌드 — GitHub Actions 문서 빌드가 통과했는가

리뷰 에티켓

• 구체적이고 실행 가능한 피드백을 제공합니다.

• 좋은 점도 함께 언급합니다.

• 의견(취향)과 필수 수정 사항을 구분합니다.