🎯 오픈 소스의 커뮤니티 스탠다드에 대해 정리합니다.

📗 Today I Learned

Community Standards

오픈소스 프로젝트의 README, 라이선스, 기여 가이드 등 핵심 문서를 체계적으로 구성해 사용자와 기여자가 쉽게 이해하고 참여할 수 있도록 돕는 기준입니다.

Github 레포지토리의 Insights → Community Standards 탭에서 확인할 수 있습니다.

• Description : 저장소에 대한 간단한 설명을 말합니다.

• README.md : 프로젝트의 목적, 사용 방법, 설치 방법 등을 설명하는 핵심 문서입니다.

• CODE_OF_CONDUCT.md : 오픈 소스 프로젝트(커뮤니티)에서 지켜야 할 예의, 차별 금지 등 행동 강령 문서입니다.

• CONTRIBUTING.md : 외부 기여자가 PR(Pull Request)나 이슈(Issue)를 만들 때 따라야 할 가이드라인 문서입니다.

• LICENSE : 프로젝트의 오픈소스 라이선스 종류 및 사용 조건을 명시한 법적 문서입니다.

• SECURITY.md : 보안 취약점을 발견했을 때 어떤 절차로 보고해야 하는지를 안내하는 문서입니다.

• ISSUE_TEMPLATE : 이슈(Issue) 등록 시 자동으로 제공되는 양식으로, 버그 리포트나 기능 요청을 체계적으로 수집할 수 있게 해줍니다.

• PULL_REQUEST_TEMPLATE.md : PR(Pull Request) 생성 시 자동으로 포함되는 양식으로, 변경 사항의 목적과 내용을 명확히 전달하도록 돕습니다.

• Repository admins accept content reports : 해당 저장소가 GitHub의 콘텐츠 신고 기능을 통해 외부 사용자의 신고를 받을 수 있는 상태인지를 나타냅니다. GitHub는 행동 강령 문서에 이메일 등 연락처 정보가 포함되어 있는지 자동으로 판단하여 이 항목을 표시합니다.

🤔 이슈(Issue)와 PR(Pull Request)은 뭘까?

Issue(이슈)는 버그, 기능 요청, 질문, 작업할 일(To-Do) 등을 기록하고 관리하는 기능입니다.

PR(Pull Request)은 코드 변경 사항을 공유하고, 코드 리뷰를 거쳐 메인 브랜치에 병합(Merge)하기 위한 요청 절차입니다.

• Pull Request(PR)가 생성되면, 팀원이나 프로젝트 관리자 등 리뷰어는 해당 변경 사항을 검토하게 됩니다. 이 과정을 코드 리뷰(Code Review)라고 합니다.

👉 이슈 템플릿 구성하는 방법

추가로 알면 좋은 문서

• NOTICE.txt : 라이선스에서 요구하는 고지 사항이나 추가적인 저작권, 상표 고지 등을 명시하는 파일입니다. (“NOTICE file must be included” 라는 조항이 있는 라이선스, 예: Apache-2.0)

• COPYRIGHT.txt : 프로젝트의 저작권자 정보를 명시하는 문서로, 공동 저작권자나 외부 코드 포함 여부 등을 명확히 할 때 사용합니다. (저작권자를 공식적으로 표기하고자 할 때 유용합니다.)

---

✏️ 회고

그동안 오픈 소스 몰랐던 파일들을 알게되어 오픈 소스를 확인할 때에 수월할 것 같다. 확실히 구조가 잡혀있는 오픈 소스들이 더 읽기도 쉽고, 협업도 쉬워보여 더욱 커뮤니티 프로필의 완성도의 중요성을 깨달았던 것 같다.