Creating a default community health file(기본 커뮤니티 상태 파일 만들기)

CONTRIBUTING 및 CODE_OF_CONDUCT 같은 기본 커뮤니티 상태 파일을 만들 수 있습니다. 기본 파일은 해당 형식의 자체 파일을 포함하지 않는 계정에서 소유한 모든 리포지토리에 사용됩니다.

이 문서의 내용

기본 커뮤니티 상태 파일 정보

기본 커뮤니티 상태 파일은 정상 및 공동 오픈 소스 프로젝트 유지관리를 위한 지침 및 템플릿을 제공하는 미리 정의된 파일 집합입니다. 리포지토리의 루트 또는 docs 또는 .github 폴더에 있는 .github라는 이름의 공개 리포지토리에 기본 커뮤니티 상태 파일을 추가할 수 있습니다. 이러한 파일을 사용하여 프로젝트 개발 및 커뮤니티 상호 작용의 다양한 측면을 자동화하고 표준화할 수 있습니다. 오픈 소스 프로젝트에서 투명성, 모범 사례, 공동 작업을 촉진하는 데 필수적입니다.

GitHub Enterprise Server은(는) 해당 계정이 소유하고 있으며 다음과 같은 위치에 해당 유형의 파일이 없는 리포지토리에 대해 이러한 기본 파일을 사용하고 표시합니다.

  • 리포지토리의 루트
  • .github 폴더
  • docs 폴더

예를 들어 자체 CONTRIBUTING 파일이 없는 리포지토리에서 문제 또는 끌어오기 요청을 생성하는 사용자는 기본 CONTRIBUTING 파일에 대한 링크를 볼 수 있습니다. 리포지토리에 자체 .github/ISSUE_TEMPLATE 폴더가 있는 경우(문제 템플릿 또는 config.yml 파일 포함), 기본 .github/ISSUE_TEMPLATE 폴더의 내용이 사용되지 않습니다.

기본 파일은 .github 리포지토리에만 저장되므로 파일 브라우저 또는 Git 기록에 나타나지 않으며 개별 리포지토리의 클론, 패키지 또는 다운로드에 포함되지 않습니다.

지원되는 파일 형식

다음 커뮤니티 상태 파일에 대한 조직 또는 개인 계정에서 기본값을 만들 수 있습니다.

커뮤니티 상태 파일설명
CONTRIBUTING.md기여 파일은 사람들이 프로젝트에 기여하는 방법을 전달합니다. 자세한 내용은 "리포지토리 기여자에 대한 지침 설정"을(를) 참조하세요.
토론 범주 양식토론 범주 양식은 커뮤니티 구성원이 리포지토리에서 새 토론을 열 때 사용할 수 있는 템플릿을 사용자 지정합니다. 자세한 정보는 "토론 범주 양식 만들기"을(를) 참조하세요.
GOVERNANCE.mdGOVERNANCE 파일을 사용하면 프로젝트가 어떻게 관리되는지 알 수 있습니다. 예를 들어 프로젝트 역할과 결정 방법에 대해 논의할 수 있습니다.
이슈 및 끌어오기 요청 템플릿과 config.yml문제 및 끌어오기 요청 템플릿은 리포지토리에서 문제 및 끌어오기 요청을 열 때 기여자가 포함할 정보를 사용자 지정하고 표준화합니다. 자세한 내용은 "문제 및 끌어오기 요청 템플릿 사용"을(를) 참조하세요.
SECURITY.mdSECURITY 파일은 프로젝트에서 보안 약점을 보고하는 방법에 대한 지침 밒 파일을 hiperlink하는 설명을 제공합니다. 자세한 내용은 "Adding a security policy to your repository(리포지토리에 보안 정책 추가)"을(를) 참조하세요.
SUPPORT.mdSUPPORT 파일을 사용하면 프로젝트에 대한 도움을 얻을 수 있는 방법에 대해 알 수 있습니다. 자세한 내용은 "프로젝트에 지원 리소스 추가"을(를) 참조하세요.

기본 라이선스 파일을 만들 수 없습니다. 프로젝트를 복제, 패키지 또는 다운로드할 때 파일이 포함되도록 라이선스 파일을 개별 리포지토리에 추가해야 합니다.

기본 파일에 대한 리포지토리 만들기

  1. 임의 페이지의 오른쪽 위에 있는 을(를) 클릭한 다음, 신규 리포지토리를 클릭합니다.

    새 항목을 만드는 옵션을 보여 주는 GitHub 드롭다운 메뉴의 스크린샷. "새 리포지토리"라는 메뉴 항목이 진한 주황색 윤곽선으로 표시되어 있습니다.

  2. 소유자 드롭다운 메뉴를 사용하고 기본 파일을 만들려는 조직 또는 개인 계정을 선택합니다.

    새 GitHub 리포지토리의 소유자 메뉴 스크린샷. 이 메뉴는 octocat과 github라는 두 가지 옵션을 표시합니다.

  3. ‘리포지토리 이름’ 필드에 .github를 입력하세요.

  4. 필요에 따라 ‘설명’ 필드에 설명을 입력합니다.

  5. 리포지토리 상태가 공용으로 설정되어 있는지 확인합니다. 기본 파일의 리포지토리는 비공개일 수 없습니다.

  6. 추가 정보를 사용하여 이 리포지토리 초기화를 선택합니다.

  7. Create repository(리포지토리 만들기)를 클릭합니다.

  8. 리포지토리에서 지원되는 커뮤니티 상태 파일 중 하나를 만듭니다. 이슈 템플릿 및 해당 구성 파일은 .github/ISSUE_TEMPLATE 폴더에 있어야 합니다. 기타 지원되는 모든 파일은 리포지토리의 루트, .github 폴더 또는 docs 폴더에 있을 수 있습니다. 자세한 내용은 "새 파일 만들기"을(를) 참조하세요.