Skip to main content

리포지토리 기여자에 대한 지침 설정

사람들이 프로젝트에 기여하는 방법을 전달하는 지침을 만들 수 있습니다.

기여 지침 링크 정보

프로젝트 기여자가 제대로 작업할 수 있도록 기여 지침이 포함된 파일을 프로젝트 리포지토리의 루트, docs 또는 .github 폴더에 추가할 수 있습니다. 끌어오기 요청을 열거나 문제를 만들면 해당 파일에 대한 링크가 표시됩니다. 기여 지침에 대한 링크도 리포지토리의 contribute 페이지에 표시됩니다. contribute 페이지에 대한 예는 github/docs/contribute를 참조하세요.

리포지토리 소유자에게 기여 지침은 사용자가 기여하는 방법을 전달하는 방법입니다.

기여자의 경우 지침은 올바른 형식의 끌어오기 요청을 제출하고 유용한 문제를 여는지 확인하는 데 도움이 됩니다.

소유자와 기여자 모두에게 기여 지침은 부적절하게 생성된 끌어오기 요청 또는 거부되었거나 다시 제출해야 하는 문제로 인한 시간과 번거로움을 줄입니다.

조직 또는 개인 계정에 대한 기본 기여 지침을 만들 수 있습니다. 자세한 정보는 "Creating a default community health file(기본 커뮤니티 상태 파일 만들기)"을(를) 참조하세요.

팁: 리포지토리 유지 관리자는 리포지토리에 대한 문제 또는 끌어오기 요청 템플릿을 만들어 문제에 대한 특정 지침을 설정할 수 있습니다. 자세한 내용은 "문제 및 끌어오기 요청 템플릿 사용"을(를) 참조하세요.

CONTRIBUTING 파일 추가

  1. GitHub.com에서 리포지토리의 기본 페이지로 이동합니다.

  2. 파일 목록 위에서 파일 추가 드롭다운 메뉴를 선택하고 새 파일 만들기를 클릭합니다.

    또는 왼쪽의 파일 트리 보기에서 을(를) 클릭합니다.

    리포지토리의 기본 페이지  스크린샷. 파일 목록 위에 "파일 추가" 레이블의 단추가 진한 주황색으로 표시됩니다. 리포지토리의 파일 트리 보기에서 더하기 기호 아이콘이 있는 단추도 진한 주황색으로 표시됩니다.

  3. 리포지토리의 루트, docs 또는 .github 디렉터리에 기여 지침을 저장할지 여부를 결정합니다. 그런 다음, 파일 이름 필드에 파일 이름 및 확장명을 입력합니다. 기여 지침 파일 이름은 대/소문자를 구분하지 않습니다. 파일 확장자가 지원되는 형식인 경우 파일은 서식 있는 텍스트 형식으로 렌더링됩니다. 자세한 내용은 "코드가 아닌 파일을 사용한 작업"을(를) 참조하세요.

    • 리포지토리의 루트 디렉터리에 기여 지침을 표시하려면 _CONTRIBUTING_을 입력합니다.
    • 리포지토리의 docs 디렉터리에 기여 지침을 표시하려면 docs/ 를 입력하여 새 디렉터리를 만든 다음 _CONTRIBUTING_을 만듭니다.
    • 리포지토리에 둘 이상의 CONTRIBUTING 파일이 포함된 경우 링크에 표시된 파일은 .github 디렉터리, 리포지토리의 루트 디렉터리, 마지막으로 docs 디렉터리 순으로 선택됩니다.
  4. 새 파일에서 기여 지침을 추가합니다. 여기에는 다음이 포함될 수 있습니다.

    • 좋은 문제 또는 끌어오기 요청을 만드는 단계입니다.
    • 외부 설명서, 우편 목록 또는 사용 규정에 대한 링크입니다.
    • 커뮤니티 및 예상되는 행동.
  5. 변경 내용 커밋... 을 클릭합니다.

  6. "커밋 메시지" 필드에, 파일의 변경 내용을 설명하는 커밋 메시지를 간결하고 명확하게 입력합니다. 커밋 메시지에서 둘 이상의 작성자가 커밋의 특성을 지정할 수 있습니다. 자세한 내용은 "여러 작성자와 커밋 만들기"을 참조하세요.

  7. 커밋 메시지 필드 아래에서 현재 분기 또는 새 분기에 커밋을 추가할지 여부를 결정합니다. 현재 분기가 기본 분기인 경우 커밋에 대한 새 분기를 만든 다음 끌어오기 요청을 만들도록 선택해야 합니다. 자세한 내용은 "끌어오기 요청 만들기"을 참조하세요.

    기본 분기에 직접 커밋하거나 새 분기를 만드는 라디오 단추를 보여 주는 GitHub 끌어오기 요청의 스크린샷. 새 분기를 선택했습니다.

  8. 변경 내용 커밋 또는 변경 내용 제안을 클릭합니다.

기여 지침의 예

도움이 필요한 경우, 기여 지침의 몇 가지 좋은 예를 살펴보세요.

추가 참고 자료