오픈 소스 문서 구조
기본 문서
LICENSE.md
- LICENSE.md 파일이나 txt 파일은 오픈 소스 라이선스 전문을 명시한 문서이다.
- 이 파일이 프로젝트에 있으면 이 프로젝트는 해당 오픈 소스 라이선스 하에 배포되어야 한다.
- 오픈 소스 프로젝트의 최상위 디렉터리에 위치한다.
추가 문서
문서 이름 | 설명 |
README.md | 프로젝트 코드의 목적, 사용 방법 등을 설명한 문서이다. |
COPYRIGHT.txt | 저작권에 대한 이야기에 중점을 둔 문서이다. |
NOTICE.txt | 오픈 소스 라이선스 개요를 담고 있는 문서이다. |
CONTRIBUTING.md | 프로젝트에 기여할 수 있는 방법과 기여 절차를 설명한 문서이다. 이 문서가 있다는 것은 컨트리뷰션을 환영한다는 의미를 가진다. |
CODE_OF_CONDUCT.md | 오픈 소스 프로젝트(커뮤니티)에 참여하는 방법에 대한 표준이 작성되어 있는 문서이다. 모든 기여를 존중하고, 서로를 존중한다는 내용과 커뮤니티 멤버간에 이슈가 발생했을 때의 문제 해결 방안에 대해 작성되어 있다. |
Github
Issues
깃허브의 레포지토리에 들어가면 위와 같이 Issues라는 탭이 있다.
여기에는 기획, 작업, 추가, 버그, 개선, 질문 등을 등록할 수 있다.
- Open: 진행 중이거나 계획(시작 전)에 대한 내용
- Close: 완료되었거나 폐기된 것
Discussions
논의를 할 때, 이슈화를 시키는 방법도 있지만 캐쥬얼하게 대화할 수 있는 Discussions라는 탭이 있다.
Discussions에서 대화하고 정리하고 이슈화해서 사용할 수도 있다.
'데브코스' 카테고리의 다른 글
[13주차 - DAY4] 오픈 소스(3) (0) | 2024.05.23 |
---|---|
[13주차 복습 발표] 싱글톤 패턴 (0) | 2024.05.22 |
[13주차 - DAY2] 오픈 소스 (0) | 2024.05.21 |
[13주차 - DAY1] 게시판 만들기(4) & 배포 (0) | 2024.05.20 |
[12주차 - DAY5] 게시판 만들기(3) (0) | 2024.05.17 |