Skip to main content

리포지토리 모범 사례

리포지토리를 효과적이고 안전하게 사용하는 방법을 알아봅니다.

README 파일 만들기

사용자가 작업을 더 쉽게 이해하고 탐색할 수 있도록 모든 리포지토리에 대한 추가 정보 파일을 만드는 것이 좋습니다.

리포지토리에 추가 정보 파일을 추가하여 프로젝트에 대한 중요한 정보를 전달할 수 있습니다. 리포지토리 라이선스, 인용 파일, 기여 지침, 사용 규정과 더불어 추가 정보는 프로젝트에 대한 기대치를 전달하며 기여를 관리하는 데 도움이 됩니다. 자세한 내용은 리포지토리 README 파일에 관하여을(를) 참조하세요.

리포지토리 보안 유지

취약성, 무단 액세스 및 기타 잠재적인 보안 위협으로부터 코드를 보호하려면 GitHub의 사용 가능한 보안 기능을 사용하여 리포지토리를 보호해야 합니다. 최소한 퍼블릭 리포지토리에 무료로 제공되는 다음 기능을 활성화해야 합니다.

  • Dependabot alerts 는 영향을 받는 종속성을 보다 안전한 버전으로 업데이트할 수 있도록 프로젝트의 종속성 네트워크 보안 취약성을 알려줍니다.
  • Secret scanning 는 리포지토리에서 비밀(예: API 키 및 토큰)을 검색하고 비밀이 발견되면 알림을 보내 리포지토리에서 비밀을 삭제할 수 있습니다.
  • 푸시 보호는 지원되는 비밀이 포함된 푸시를 차단하여 사용자(및 협력자)가 처음에 리포지토리에 비밀을 도입하는 것을 방지합니다.
  • Code scanning 는 리포지토리 코드의 취약성 및 오류를 식별하므로 이러한 문제를 조기에 해결하고 악의적인 행위자가 취약성이나 오류를 악용하지 않도록 방지할 수 있습니다.

또한 다음을 고려할 수도 있습니다.

  • 리포지토리에 SECURITY.md 파일을 추가합니다. SECURITY.md 파일은 공동 작업자에게 프로젝트에서 발견된 보안 취약성을 보고하는 방법에 대한 지침을 제공하고 책임 있는 공개를 장려합니다.
  • 리포지토리에 대해 "프라이빗 취약성 보고"를 활성화하면 공동 작업자와 보안 연구원이 리포지토리에서 발견되는 취약성을 비공개로 공개할 수 있습니다.

자세한 내용은 리포지토리 보안 설정을 위한 빠른 시작을(를) 참조하세요.

포크 대신 브랜치를 권장

협업을 간소화하려면 일반 협력자가 단일 리포지토리에서 작업하여 리포지토리 간이 아닌 분기 간에 끌어오기 요청을 만드는 것이 좋습니다. 포킹은 오픈 소스 기여자처럼 프로젝트와 관련 없는 사람들의 기여를 받아들이기에 가장 적합한 방식입니다.

분기 워크플로를 사용하는 동안 main과 같은 중요한 분기의 품질을 유지하려면 필수 상태 확인 및 끌어오기 요청 검토로 보호된 분기를 사용합니다. 자세한 내용은 보호된 분기 정보을(를) 참조하세요.

Git 대용량 파일 스토리지 사용

성능을 최적화하기 위해 GitHub은(는) 리포지토리에 허용되는 파일의 크기를 제한합니다. 자세한 내용은 GitHub의 대용량 파일 정보을(를) 참조하세요.

Git 리포지토리에서 큰 파일을 추적하려면 Git 대용량 파일 스토리지(Git LFS)을(를) 사용하는 것이 좋습니다. 자세한 내용은 Git 대용량 파일 저장소에 대하여을(를) 참조하세요.

실습

리포지토리 관리에 대한 실습 경험을 쌓기 위해 리포지토리 관리 소개 기술 연습을 시도해 보세요.