추가 정보에 대한 정보
리포지토리에 추가 정보 파일을 추가하여 프로젝트에 대한 중요한 정보를 전달할 수 있습니다. README는 리포지토리 라이선스, 인용 파일, 기여 지침 및 행동 강령과 함께 프로젝트에 대한 기대치를 전달하고 기여를 관리하는 데 도움이 됩니다.
프로젝트에 대한 지침을 제공하는 방법에 대한 자세한 내용은 "프로젝트에 사용 규정 추가" 및 "정상적인 기여를 위한 프로젝트 설정"을 참조하세요.
방문자가 리포지토리를 방문할 때 첫 번째로 보게 되는 항목이 추가 정보인 경우가 많습니다. 추가 정보 파일에는 일반적으로 다음 정보가 포함되어 있습니다.
- 프로젝트에서 수행하는 작업
- 프로젝트가 유용한 이유
- 사용자가 프로젝트를 시작하는 방법
- 사용자가 프로젝트와 관련된 도움을 받을 수 있는 위치
- 프로젝트를 유지 관리하고 기여하는 사람
리포지토리의 숨겨진 .github, 루트 또는 docs 디렉터리에 추가 정보 파일을 배치하면 GitHub Enterprise Cloud에서 추가 정보를 인식하고 리포지토리 방문자에게 자동으로 표시합니다.
리포지토리에 둘 이상의 추가 정보 파일이 포함된 경우 표시된 파일은 .github 디렉터리, 리포지토리의 루트 디렉터리, 마지막으로 docs 디렉터리 순으로 선택됩니다.
사용자 이름과 동일한 이름의 퍼블릭 리포지토리 루트에 README 파일을 추가하면 해당 README가 프로필 페이지에 자동으로 표시됩니다. GitHub Flavored Markdown을 사용하여 프로필 README를 수정하여 프로필에 맞춤형 섹션을 만들 수 있습니다. 자세한 내용은 "프로필 추가 정보 관리"을 참조하세요.
추가 정보 파일의 자동 생성된 목차
추가 정보 파일을 포함하여 리포지토리에 있는 Markdown 파일의 렌더링된 뷰를 위해 GitHub Enterprise Cloud는 섹션 제목에 따라 목차를 자동으로 생성합니다. 렌더링된 페이지의 왼쪽 위에 있는 메뉴 아이콘을 클릭하여 추가 정보 파일의 목차를 볼 수 있습니다.
추가 정보 파일 및 Blob 페이지의 섹션 링크
를 노출하도록 섹션 제목을 마우스로 가리키면 렌더링된 파일의 섹션에 직접 연결할 수 있습니다.
추가 정보 파일의 상대 링크 및 이미지 경로
렌더링된 파일에서 상대 링크 및 이미지 경로를 정의하여 판독기에서 리포지토리의 다른 파일로 이동할 수 있습니다.
상대 링크는 현재 파일을 기준으로 하는 링크입니다. 예를 들어 리포지토리의 루트에 추가 정보 파일이 있고 docs/CONTRIBUTING.md에 다른 파일이 있는 경우 추가 정보의 CONTRIBUTING.md에 대한 상대 링크는 다음과 같습니다.
[Contribution guidelines for this project](docs/CONTRIBUTING.md)
GitHub Enterprise Cloud는 현재 위치한 분기에 따라 상대 링크 또는 이미지 경로를 자동으로 변환하므로 링크 또는 경로는 항상 작동합니다. 링크의 경로는 현재 파일을 기준으로 합니다. / 시작 링크는 리포지토리 루트를 기준으로 합니다. ./ 및 ../와 같은 모든 상대 링크 피연산자를 사용할 수 있습니다.
상대 링크는 리포지토리를 복제하는 사용자가 사용하기 더 쉽습니다. 절대 링크는 리포지토리의 복제본에서 작동하지 않을 수 있습니다. 상대 링크를 사용하여 리포지토리 내의 다른 파일을 참조하는 것이 좋습니다.
Wikis
추가 정보에는 개발자가 프로젝트 사용 및 기여를 시작하는 데 필요한 정보만 포함되어야 합니다. 긴 설명서가 Wiki에 가장 적합합니다. 자세한 내용은 "위키 정보"을 참조하세요.