.github Repository

이 .github 레포지토리는 조직 내의 모든 서브 레포지토리에 공통으로 적용될 설정, 이슈 템플릿, PR 템플릿, 그리고 기타 가이드라인을 포함하고 있습니다. 이 레포지토리의 설정을 통해 조직의 코드베이스 관리, 이슈 처리 방식, PR 절차 등을 통일하여 일관성 있는 협업을 도모합니다.

---

주요 구성

1. 이슈 템플릿 (ISSUE_TEMPLATE/)

• 각 레포지토리에서 발생하는 이슈의 종류에 따라 선택할 수 있는 템플릿을 제공합니다.
  • 버그 리포트: 버그 발견 시 상세 정보 제공을 위한 템플릿
  • 기능 제안: 새로운 기능이나 개선 사항을 제안하는 템플릿
  • 기타 요청: 문서화 요청, 질문 등 기타 이슈의 정리를 위한 템플릿

2. PR 템플릿 (PULL_REQUEST_TEMPLATE.md)

• 모든 Pull Request에 공통적으로 적용되는 템플릿입니다.
• 코드 변경 사항을 명확하게 기술하고, 리뷰어들이 주의 깊게 확인해야 할 사항을 작성하도록 안내합니다.
• PR 템플릿에는 다음을 포함합니다:
  • 변경 사항 요약
  • 관련 이슈 링크
  • 테스트 항목
  • 추가 코멘트

3. settings.yml

• settings.yml 파일을 통해 조직 내 서브 레포지토리의 기본 설정을 관리합니다.
• 주요 설정 항목:
  • 기본 브랜치 설정
  • 팀별 접근 권한 관리
  • 자동화된 레이블 설정
  • GitHub Actions 워크플로우의 기본값 설정

---

사용 방법

이 .github 레포지토리에 저장된 설정 파일은 조직 내 모든 레포지토리에 자동으로 상속되며, 개별 레포지토리에서 특별한 설정을 추가할 필요 없이 동일한 이슈, PR 템플릿을 사용할 수 있습니다.

이슈 생성 시

• 각 이슈 템플릿을 선택하여 정보를 작성하면 됩니다. 버그와 기능 요청 템플릿은 각각의 목적에 맞는 필드를 포함하고 있어, 문제 해결이 효율적으로 이루어질 수 있도록 돕습니다.

Pull Request 생성 시

• PR 작성자는 PULL_REQUEST_TEMPLATE.md을 따라 상세한 정보를 기재함으로써, 코드 변경 사항을 더욱 명확히 전달할 수 있습니다.

---

유지보수 및 관리

이 .github 레포지토리는 조직의 유지보수 가이드라인에 따라 주기적으로 업데이트됩니다. 템플릿 및 설정에 대한 개선 사항은 이 레포지토리로 Pull Request를 제출하여 관리자가 승인하는 절차를 통해 반영됩니다.

• 이슈 템플릿 수정: 필요 시 ISSUE_TEMPLATE 디렉토리 내의 각 템플릿 파일을 업데이트합니다.
• PR 템플릿 수정: 변경이 필요하면 PULL_REQUEST_TEMPLATE.md 파일을 수정하여 조직의 코드 리뷰 방침에 맞게 유지보수합니다.
• 설정 파일 업데이트: settings.yml 파일은 조직의 정책 변화에 따라 업데이트되며, 각 서브 레포지토리에서 일관성을 유지하도록 합니다.

---

기여 방법

이 .github 레포지토리의 업데이트가 필요한 경우, 새로운 이슈를 열거나 직접 Pull Request를 제출할 수 있습니다. 모든 변경 사항은 관리자의 검토를 거쳐 승인되며, 조직 내의 모든 서브 레포지토리에 즉시 반영됩니다.

---

이 .github 레포지토리를 통해 조직 내 코드와 협업에 대한 일관된 경험을 제공하고자 합니다. 지속적인 개선을 통해 더 나은 협업 환경을 만들어 나가겠습니다.