기여 지침 링크 정보
프로젝트 기여자가 제대로 작업할 수 있도록 기여 지침이 포함된 파일을 프로젝트 리포지토리의 루트, docs 또는 .github 폴더에 추가할 수 있습니다. 끌어오기 요청을 열거나 문제를 만들면 해당 파일에 대한 링크가 표시됩니다. 기여 지침에 대한 링크도 리포지토리의 contribute 페이지에 표시됩니다. contribute 페이지에 대한 예는 github/docs/contribute를 참조하세요.
리포지토리 소유자에게 기여 지침은 사용자가 기여하는 방법을 전달하는 방법입니다.
기여자의 경우 지침은 올바른 형식의 끌어오기 요청을 제출하고 유용한 문제를 여는지 확인하는 데 도움이 됩니다.
소유자와 기여자 모두에게 기여 지침은 부적절하게 생성된 끌어오기 요청 또는 거부되었거나 다시 제출해야 하는 문제로 인한 시간과 번거로움을 줄입니다.
조직 또는 개인 계정에 대한 기본 기여 지침을 만들 수 있습니다. 자세한 내용은 "Creating a default community health file(기본 커뮤니티 상태 파일 만들기)"을 참조하세요.
팁: 리포지토리 유지 관리자는 리포지토리에 대한 문제 또는 끌어오기 요청 템플릿을 만들어 문제에 대한 특정 지침을 설정할 수 있습니다. 자세한 내용은 "문제 및 끌어오기 요청 템플릿 사용"을 참조하세요.
CONTRIBUTING 파일 추가
- GitHub Enterprise Server 인스턴스에서 리포지토리의 기본 페이지로 이동합니다. 1. 파일 목록 위에서 파일 추가 드롭다운을 사용하여 새 파일 만들기를 클릭합니다.
- 리포지토리의 루트,
docs또는.github디렉터리에 기여 지침을 저장할지 여부를 결정합니다. 그런 다음, 파일 이름 필드에 템플릿의 이름 및 확장명을 입력합니다. 기여 지침 파일 이름은 대/소문자를 구분하지 않습니다. 파일 확장자가 지원되는 형식인 경우 파일은 서식 있는 텍스트 형식으로 렌더링됩니다. 자세한 내용은 "비 코드 파일 사용"을 참조하세요.
- 리포지토리의 루트 디렉터리에 기여 지침을 표시하려면 CONTRIBUTING을 입력합니다.
- 리포지토리의
docs디렉터리에 기여 지침을 표시하려면 docs/ 를 입력하여 새 디렉터리를 만든 다음docsCONTRIBUTING을 만듭니다. - 리포지토리에 둘 이상의 CONTRIBUTING 파일이 포함된 경우 링크에 표시된 파일은
.github디렉터리, 리포지토리의 루트 디렉터리, 마지막으로docs디렉터리 순으로 선택됩니다.
- 새 파일에서 기여 지침을 추가합니다. 여기에는 다음이 포함될 수 있습니다.
- 좋은 문제 또는 끌어오기 요청을 만드는 단계입니다.
- 외부 설명서, 우편 목록 또는 사용 규정에 대한 링크입니다.
- 커뮤니티 및 예상되는 행동.
- 페이지 아래쪽에 파일에 대한 변경 내용을 설명하는 짧고 의미 있는 커밋 메시지를 입력합니다. 커밋 메시지에서 둘 이상의 작성자가 커밋의 특성을 지정할 수 있습니다. 자세한 내용은 "여러 작성자와 커밋 만들기"을 참조하세요.
기여 지침의 예
도움이 필요한 경우, 기여 지침의 몇 가지 좋은 예를 살펴보세요.
추가 참고 자료
- 오픈 소스 가이드의 “오픈 소스 프로젝트 시작”
- "리포지토리에 라이선스 추가"