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

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

이 문서의 내용

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

기본 커뮤니티 상태 파일은 정상적인 오픈 소스 프로젝트 유지관리를 위한 지침과 템플릿을 제공하는 미리 정의된 파일 집합입니다. 이러한 파일들은 프로젝트 개발 및 커뮤니티 상호 작용의 여러 측면을 자동화하고 표준화하여 투명성, 모범 사례, 협업을 촉진하는 데 기여합니다.

공용 리포지토리에 기본 .github 커뮤니티 상태 파일을 추가할 수 있습니다. GitHub는 다음 순서에 따라 해당 형식의 자체 파일이 없는 계정 소유 리포지토리에 대한 기본 파일을 사용하고 표시합니다.

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

현재 리포지토리에 해당 파일이 없으면 GitHub는 동일한 우선순위에 따라 .github 리포지토리의 기본 파일을 사용합니다.

참고 항목

조직 전체에 템플릿을 적용하려면 리포지토리가 .githubpublic여야 합니다. 프라이빗 .github 리포지토리는 지원되지 않습니다.

예를 들어 자체 CONTRIBUTING.md 파일이 없는 리포지토리에서 이슈 또는 풀 리퀘스트를 생성하는 사용자는 CONTRIBUTING.md 리포지토리의 기본 .github 브랜치에 대한 링크를 볼 수 있습니다. 그러나 리포지토리 자체 .github/ISSUE_TEMPLATE 폴더에 문제 템플릿이나 _config.yml 파일과 같은 파일이 있다면, 기본 .github/ISSUE_TEMPLATE 폴더의 콘텐츠는 사용되지 않습니다. 이를 통해 리포지토리 관리자는 리포지토리별로 특정 템플릿이나 콘텐츠를 활용하여 기본 파일을 재설정할 수 있습니다.

파일을 .github 리포지토리에 저장하면 기본값을 한 곳에서 변경할 수 있습니다. 또한 개별 리포지토리의 파일 브라우저나 Git 기록에 나타나지 않으며, 복제본, 패키지 또는 다운로드 항목에도 포함되지 않습니다.

보안 정책 정보

보안 보고 지침을 명확하게 사용할 수 있도록 하여 사용자가 선호하는 통신 채널을 통해 리포지토리에서 찾은 모든 보안 취약성을 쉽게 보고할 수 있습니다.

실제 SECURITY.md 파일의 예는 https://github.com/electron/electron/blob/main/SECURITY.md을(를) 참조하세요.

지원되는 파일 형식

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

커뮤니티 상태 파일설명
CONTRIBUTING.md기여 파일은 사람들이 프로젝트에 어떻게 기여할 수 있는지 알려줍니다. 자세한 내용은 리포지토리 기여자에 대한 지침 설정을(를) 참조하세요.
토론 범주 양식토론 범주 양식은 커뮤니티 구성원이 리포지토리에서 새로운 토론을 시작할 때 사용할 수 있는 템플릿을 맞춤 설정합니다. 자세한 내용은 토론 범주 양식 만들기을(를) 참조하세요.
GOVERNANCE.mdGOVERNANCE 파일을 통해 프로젝트 관리 방식을 확인할 수 있습니다. 예를 들어, 프로젝트의 역할 분담과 의사결정 방식에 대해 논의할 수 있습니다.
이슈 및 끌어오기 요청 템플릿과 config.yml이슈 및 풀 리퀘스트 템플릿은 기여자가 리포지토리에서 이슈 및 풀 리퀘스트를 열 때 포함할 정보를 사용자 정의하고 표준화합니다. 자세한 내용은 문제 및 끌어오기 요청 템플릿 사용을(를) 참조하세요.

문제 템플릿에서 레이블을 설정하는 경우, 해당 레이블은 .github 리포지토리와 템플릿이 사용될 리포지토리에 생성되어야 합니다.
SECURITY.mdSECURITY 파일은 프로젝트에서 보안 취약점을 보고하는 방법에 대한 지침을 제공하고 관련 파일에 대한 하이퍼링크를 포함합니다. 자세한 내용은 Adding a security policy to your repository(리포지토리에 보안 정책 추가)을(를) 참조하세요.
SUPPORT.mdSUPPORT 파일을 통해 프로젝트 관련 도움을 받는 방법을 확인할 수 있습니다. 자세한 내용은 프로젝트에 지원 리소스 추가을(를) 참조하세요.

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

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

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

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

  2. 소유자 드롭다운 메뉴에서 기본 파일을 생성할 조직 또는 개인 계정을 선택하세요.

    새 GitHub 리포지토리의 소유자 메뉴 스크린샷. 이 메뉴는 octocat과 github, 이렇게 두 가지 옵션을 보여줍니다.

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

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

  5. 리포지토리 상태가 public로 설정되어 있는지 확인합니다. 기본 파일의 리포지토리는 공개되어야 합니다.

  6.        **README 추가**를 **켜기**로 전환합니다.

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

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