[TIL] 11/26 오픈 소스와 깃허브

이전 내용

[TIL] 11/25 오픈 소스란?

 

 

1.5. 오픈 소스 문서 구조

 

<기본 문서>

 

- LICENSE.md/.txt: 오픈 소스 라이선스 전문 명시 문서

이 파일이 프로젝트에 있으면 이 프로젝트는 이 오픈 소스 라이선스 하에 배포된다/되어야 한다라는 의미.

그리고 이 파일은 오픈 소스 프로젝트의 최상위 디렉토리에 위치해 있어야 한다. 

 

<추가 문서>

 

- README.md: 프로젝트 코드의 목적, 사용 방법 설명 문서

 

- COPYRIGHTt.txt: 저작권에 관한 이야기

 

- NOTICE.txt: 오픈 소스 라이선스 개요

 

- Contributing.md (or .txt): 프로젝트에 어떻게 기여할 수 있는지 설명하는 문서로 해당 프로젝트에 기여하는 절차를 안내

(결국 소스 코드에 기여하는 것을 환영한다는 말과 같다)

 

- CODE_OF_CONDUCT.md: 오픈 소스 프로젝트(커뮤니티)에 참여하는 방법에 대한 표준 = 모든 기여 존중 / 서로 존중 / 호의적, 포용적 환경 (+ 커뮤니티 멤버간의 이슈 발생시 문제 해결 방안에 대해서도 나와있음)

 

 

위의 파일들을 오픈 소스 프로젝트(=커뮤니티)의 상태 파일이라고 한다. 깃허브는 커뮤니티에 대한 행동 기준, 공정한 방식으로 즐겁게 생산하는 개발 환경을 지향하기 때문에 위의 파일들을 체크리스트로 확인할 수 있도록 만들어 두기도 했다. 

 

(레포 -> insight -> Community Standard)

 

 

- Issue templates

 

먼저 프로젝트에서 발생한 이슈란?

-> 기획 / 작업 / 추가 / 버그 / 개선 .. 등 프로젝트에서 발생할 수 있는 모든 활동에 대한 이슈

-> 프로젝트를 하면서 추적하고 싶은 무엇이든 괜찮음

-> 이슈 템플릿이 존재하면 이슈를 통일감 있게 올릴 수 있다. (관리 쉬움)

 

1) Open: 진행 중, 계획 (시작 전)

2) Closed: 완료, 중단

 

- pull request templates

 

pull request 란?

-> branch 가 branch 에게 합쳐달라고 요청하는 것

-> 코드 리뷰는 pr 단계에서 일어남 (합칠지 말지 코드리뷰)

-> 이슈 템플릿과 비슷하게 pr 템플릿이 있다면 통일감 있게 pr 을 날릴 수 있고 관리가 쉽다.

 

(이슈, pr 모두 깃허브가 직접적으로 템플릿을 제공하는 것은 아니지만, 더 나은 개발 환경을 위해 있냐고 체크해주는 것!)