기본 커뮤니티 상태 파일 정보
기본 커뮤니티 상태 파일은 정상 및 공동 작업 오픈 소스 프로젝트를 유지 관리하기 위한 지침 및 템플릿을 제공하는 미리 정의된 파일 집합입니다. 이러한 파일들은 프로젝트 개발 및 커뮤니티 상호 작용의 여러 측면을 자동화하고 표준화하여 투명성, 모범 사례, 협업을 촉진하는 데 기여합니다.
라는 .github리포지토리에 기본 커뮤니티 상태 파일을 추가할 수 있습니다.
리포지토리는 .github공용이어야 합니다.
GitHub 는 대상 리포지토리의 표시 유형에 관계없이 해당 형식의 자체 파일이 없는 계정 소유의 모든 리포지토리에 대한 기본 파일을 사용하고 표시합니다. 둘 이상의 위치에 GitHub 저장할 수 있는 지원되는 파일의 경우 다음 우선 순위 순서를 사용합니다.
.github폴더- 리포지토리의 루트
docs폴더
현재 리포지토리에서 해당 파일을 찾을 수 없으면, GitHub는 .github 리포지토리의 기본 파일을 사용합니다. 둘 이상의 위치에 저장할 수 있는 파일의 경우 GitHub는 .github 리포지토리에서 동일한 우선순위 순서를 따릅니다.
예를 들어 자체 CONTRIBUTING.md 파일이 없는 리포지토리에서 이슈 또는 풀 리퀘스트를 생성하는 사용자는 CONTRIBUTING.md 리포지토리의 기본 .github 브랜치에 대한 링크를 볼 수 있습니다. 그러나 리포지토리가 자체 .github/ISSUE_TEMPLATE 폴더에서 유효한 문제 템플릿 또는 문제 템플릿 구성을 정의하는 경우 기본 .github/ISSUE_TEMPLATE 폴더의 콘텐츠는 사용되지 않습니다. 이렇게 하면 리포지토리 유지 관리자가 리포지토리별로 특정 템플릿 또는 콘텐츠를 사용하여 기본 파일을 재정의할 수 있습니다.
파일을 .github 리포지토리에 저장하면 기본값을 한 곳에서 변경할 수 있습니다. 또한 개별 리포지토리의 파일 브라우저나 Git 기록에 나타나지 않으며, 복제본, 패키지 또는 다운로드 항목에도 포함되지 않습니다.
리포지토리 관리자는 커뮤니티 표준 체크리스트를 활용하여 프로젝트가 사용자와 참여를 유도하는 데 필요한 권장 기준을 충족하는지 확인할 수 있습니다. 자세한 내용은 퍼블릭 리포지토리에 대한 커뮤니티 프로필 정보을(를) 참조하세요.
보안 정책 정보
누군가가 프로젝트에서 보안 취약성을 보고한 후 취약성에 대한 정보를 공개, 수정 및 게시하는 데 사용할 GitHub Security Advisories 수 있습니다. 취약성 GitHub을 보고하고 공개하는 프로세스에 대한 자세한 내용은 보안 취약성의 조정된 공개을 참조하세요. 리포지토리 보안 권고에 대한 자세한 내용은 리포지토리 보안 공지을(를) 참조하세요.
실제 SECURITY.md 파일의 예는 https://github.com/electron/electron/blob/main/SECURITY.md을(를) 참조하세요.
지원되는 파일 형식
다음 커뮤니티 상태 파일에 대해 조직 또는 개인 계정에서 기본값을 설정할 수 있습니다.
| 커뮤니티 상태 파일 | 설명 |
|---|---|
| CODE_OF_CONDUCT.md | CODE_OF_CONDUCT 파일은 커뮤니티에 참여하는 방법에 대한 표준을 정의합니다. 자세한 내용은 프로젝트에 사용 규정 추가을 참조하세요. |
| CONTRIBUTING.md | 기여 파일은 사람들이 프로젝트에 어떻게 기여할 수 있는지 알려줍니다. 자세한 내용은 리포지토리 기여자에 대한 지침 설정을(를) 참조하세요. |
| 토론 범주 양식 | 토론 범주 양식은 커뮤니티 구성원이 리포지토리에서 새로운 토론을 시작할 때 사용할 수 있는 템플릿을 맞춤 설정합니다. 자세한 내용은 토론 범주 양식 만들기을(를) 참조하세요. |
| FUNDING.yml | FUNDING 파일은 리포지토리에 스폰서 단추를 표시하여 오픈 소스 프로젝트에 대한 자금 조달 옵션의 가시성을 높입니다. 자세한 내용은 리포지토리에 스폰서 단추 표시을(를) 참조하세요. |
| 이슈 및 끌어오기 요청 템플릿과 config.yml | 이슈 및 풀 리퀘스트 템플릿은 기여자가 리포지토리에서 이슈 및 풀 리퀘스트를 열 때 포함할 정보를 사용자 정의하고 표준화합니다. 자세한 내용은 문제 및 풀 리퀘스트 템플릿에 대해을(를) 참조하세요. 문제 템플릿에서 레이블을 설정하는 경우, 해당 레이블은 .github 리포지토리와 템플릿이 사용될 리포지토리에 생성되어야 합니다. |
| SECURITY.md | SECURITY 파일은 프로젝트에서 보안 취약점을 보고하는 방법에 대한 지침을 제공하고 관련 파일에 대한 하이퍼링크를 포함합니다. 자세한 내용은 Adding a security policy to your repository(리포지토리에 보안 정책 추가)을(를) 참조하세요. |
| SUPPORT.md | SUPPORT 파일을 통해 프로젝트 관련 도움을 받는 방법을 확인할 수 있습니다. 자세한 내용은 프로젝트에 지원 리소스 추가을(를) 참조하세요. |
기본 라이선스 파일을 만들 수 없습니다. 프로젝트를 복제, 패키지 또는 다운로드할 때 파일이 포함되도록 라이선스 파일을 개별 리포지토리에 추가해야 합니다.
기본 파일에 대한 리포지토리 만들기
-
임의 페이지의 오른쪽 위에 있는 을(를) 클릭한 다음, 신규 리포지토리를 클릭합니다.
-
소유자 드롭다운 메뉴에서 기본 파일을 생성할 조직 또는 개인 계정을 선택하세요.
- ‘리포지토리 이름’ 필드에 .github를 입력하세요.
- 필요에 따라 "설명" 필드에 설명을 입력합니다.
- 리포지토리 상태가 공용으로 설정되어 있는지 확인합니다. 기본 파일의 리포지토리는 공개되어야 합니다.
- README 추가를 켜기로 전환합니다.
- Create repository(리포지토리 만들기)를 클릭합니다.
- 리포지토리에서 지원되는 커뮤니티 상태 파일 중 하나를 만듭니다. 토론 범주 양식은 라는
.github/DISCUSSION_TEMPLATE폴더에 있어야 합니다. 이슈 템플릿과 해당 구성 파일은.github/ISSUE_TEMPLATE폴더 안에 위치해야 합니다.
FUNDING.yml 파일은 .github 폴더에 있어야 합니다.
지원되는 다른 모든 파일은 리포지토리의 루트, .github 폴더 또는 docs 폴더에 있을 수 있습니다. 자세한 내용은 새 파일 만들기을(를) 참조하세요.