문서 및 README
누군가가 프로젝트를 설치, 실행, 구성 또는 사용하는 방식에 영향을 미치는 변경 사항이 발생하면 동일한 변경에서 README.md를 업데이트하세요.
README는 다음을 간략히 다루어야 합니다:
- 프로젝트가 무엇인지 (1-2문장).
- 요구 사항 및 설치 단계.
- 실행, 테스트 및 빌드 방법 — 복사하여 붙여넣을 수 있는 명령어.
- 구성: 목적과 예제 값이 포함된 모든 환경 변수 (실제 비밀번호 제외).
- 주요 기능에 대한 간단한 사용 예제.
규칙:
- 변경 사항이 영향을 미치는 섹션만 편집하고 전체 파일을 다시 작성하지 마세요.
- 문서화하는 모든 명령어가 실제로 작동하는지 확인하세요.
- 영어, 짧은 문장, 마케팅 언어 사용 금지.