프로젝트 가이드

오픈 소스 저장소용 CONTRIBUTING.md 템플릿

CONTRIBUTING.md는 ‘도움을 주고 싶다’는 마음을 유용한 이슈나 풀 리퀘스트로 이어 줍니다. 지원하는 가장 작은 기여와 검증 방법을 설명하세요. 요구 사항은 아무도 따르지 않는 거창한 절차가 아니라 프로젝트의 실제 운영 방식을 반영해야 합니다.

GitHubStart 편집팀 · 업데이트

기여 템플릿을 복사하고 조정하기

자리표시자를 바꾸고 모든 명령과 링크를 확인하세요. 애플리케이션 코드를 바꿀 준비가 안 된 기여자도 문서 수정과 버그 보고로 참여할 수 있도록 환영하세요.

# 기여하기

## 시작하기 전에
README를 읽고 기존 이슈를 확인하세요.
큰 변경은 구현 전에 접근법을 논의하세요.

## 로컬 설정
[필요한 런타임과 검증된 설정 명령]

## 버그 보고
버전, 환경, 단계, 예상 결과, 실제 결과를 포함하세요.
로그에서 비밀 정보와 개인 데이터를 제거하세요.

## 풀 리퀘스트 제출
- 문제와 제안하는 변경을 설명하세요.
- 변경 범위를 집중시키세요.
- [프로젝트별 검사]를 실행하세요.
- 영향을 받는 문서를 갱신하세요.

## 검토
[검토자, 응답 방법, 현실적인 대응 가능 시간]

## 다른 도움 방법
[문서, 예시, 번역 또는 재현 가능한 보고]

지침을 쉽게 찾게 하기

GitHub는 저장소 루트, docs 또는 .github 디렉터리의 기여 지침을 인식합니다. README에서도 파일에 링크하여 프로젝트 소개를 읽는 사람이 곧바로 절차를 찾을 수 있게 하세요.

실제 저장소의 기여 진입점에서 경로를 검토하세요. 지침 파일이 여러 개라면 충돌하는 안내를 정리하세요. README의 설정 명령과 기여 가이드의 다른 미지원 명령이 기여자를 혼란스럽게 해서는 안 됩니다.

접근하기 쉬운 첫 기여 하나 설계하기

지원되는 런타임의 예시 수정처럼 결과가 명확한 작은 작업을 선택하세요. 문제 재현 방법, 바뀌어야 할 동작, 완료 확인 방법을 설명하세요. 문서화되지 않은 내부 지식이 필요하다면 초보자 친화적이라고 표시하지 마세요.

검토 가능한 시간을 솔직하게 밝히세요. 응답 시간을 약속할 수 없다면 기여자가 상태를 확인하는 방법을 설명하세요. 명확한 경계는 중단되는 작업을 줄이며 모든 기여를 병합하겠다는 약속보다 유용합니다.

자주 묻는 질문

CONTRIBUTING.md가 README.md를 대체하나요?

아닙니다. README는 프로젝트와 사용 방법을 설명하고, 기여 지침은 변경 제안 및 검증 방법을 설명합니다.

다른 프로젝트의 테스트 명령을 복사해야 하나요?

그 명령이 자신의 프로젝트에도 올바를 때만 가능합니다. 실제로 확인한 명령으로 자리표시자를 바꾸세요.

기여 지침이 더 많은 기여자를 보장하나요?

아닙니다. 관심 있는 사람의 불확실성을 줄이지만 프로젝트의 유용성, 작업 품질, 관리자의 후속 대응도 중요합니다.

참고 자료