📚 Part 3 오픈소스 문서 구조
📌 오픈소스 라이선스 적용 방법
오픈소스를 가져다 쓰고 싶으면,,,
프로젝트에 사용시 → 깃허브 레포지토리 Readme / License.txt
https://opensource.guide/ko/
오픈소스에 대해 가이드를 해주는 사이트(깃허브 가이드). 특히 깃허브에 프로젝트를 올릴 때 어떤 것을 신경써야 하는지 알려줌
웬만하면 제약이 적은 MIT 라이선스를 사용하자..!
📌 깃허브에서의 오픈소스
GitHub의 공개 리포지토리는 오픈 소스 소프트웨어를 공유하는 데 자주 사용됨. 리포지토리가 진정으로 오픈 소스가 되려면 다른 사용자가 소프트웨어를 자유롭게 사용, 변경 및 배포할 수 있도록 라이선스를 부여해야 함.
https://docs.github.com/ko/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository
프로젝트 중간에 언제든지 오픈소스 라이선스를 포함할 수 있음
📌 오픈소스 문서 구조
🔗 기본 문서
LICENSE.md/.txt: 오픈소스 라이선스 전문 명시 문서- 즉, 이 파일이 프로젝트에 있으면 이 프로젝트는 이 오픈소스 라이선스 하에 배포되며, 배포되어야 한다는 뜻
- "오픈소스 프로젝트의 최상위 디렉토리"에 존재함
🔗 추가 문서
README.me: 프로젝트 코드의 목적, 사용 방법을 설명하는 문서COPYRIGHT.txt: 저작권에 초점을 둠NOTICE.txt: 오픈소스 라이선스 개요Contributing.md: 프로젝트에 기여하고 싶다면 보는 문서- 프로젝트에 어떻게 기여할 수 있는지 설명한 문서 (코드를 고치거나, 개선, 오타, 기능 추가 등)
- 해당 프로젝트에 기여할 수 있는 절차를 안내한다.
- cf. pull request : 메인 코드에 합쳐도 되는지 요청하는 것
code of conduct: 오픈소스 프로젝트(커뮤니티)에 참여하는 방법에 대한 표준- = 모든 기여를 존중하며, 개발자 간 서로를 존중한다.
- 호의적이고 포용적인 환경에서 오픈소스를 개발해나가는 목적
- + 커뮤니티 멤버 간 이슈가 발생한다면 문제 해결 방안에 대해서도 다룬다.
- 최대한 윤리적으로 모두를 위해, 모두를 존중하는 프로젝트를 만들자는 취지
📚 Part 4 오픈소스 구성요소
📌 오픈소스 프로젝트(=커뮤니티) 상태 파일
🔗 <커뮤니티 프로필 “권장” 체크리스트>
LICENSE.md/.txtREADME.mdCOPYRIGHT.txtNOTICE.txtContributing.mdcode of conduct
깃허브는 커뮤니티에 대한 행동 기준! 공정한 방식으로 즐겁게 생산하는 환경을 추구한다
커뮤니티를 빌딩한다 = 오픈소스 프로젝트를 생성한다
📌 깃허브 이슈(Issue)란?
프로젝트에서 발생할 수 있는 모든 활동에 대한 이슈
- 기획
- 작업
- 추가
- 버그
- 개선
- 질문
...
cf. Jira (프로젝트 관리 시스템)
🔗 Open
진행 중, 계획 (시작 전)
🔗 Close
완료, 중단
📌 Pull Request란?
- Pull : 당기다
- Request : 요청
Branch가 Brach에게 요청하는 것!
Pull Request (PR) 요청 후 코드 리뷰
📌 깃허브 Discussion (토론 게시판)
오픈소스 또는 내부 프로젝트를 중심으로 커뮤니티를 위한 공동 커뮤니케이션 포럼임. 서로 아이디어를 공유하고, 의견을 나누며 새로운 아이디어를 창조할 수 있다. 또한 사용자 피드백을 받을 수 있음.
