프로젝트 사용시 > 깃허브 레포지토리 README.md / License.txt
GitHub에서 제공하는 오픈소스 가이드
https://opensource.guide/ko/
GitHub에서 새로운 프로젝트를 만들 때, 라이선스를 추가할 것인지 물어봅니다.
https://docs.github.com/ko/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository
Repository를 생성할때 해당 옵션을 설정 해 줄수 있습니다.
Repository를 생성할때 라이센스를 추가하려면 해당 링크에 들어가서 따라하면 됩니다.
https://docs.github.com/en/communities/setting-up-your-project-for-healthy-contributions/adding-a-license-to-a-repository
오픈소스 문서 구조
<기본문서>
- LICENSE.md/ LICENSE.txt : 오픈소스 라이선스 전문 명시 문서
이 파일이 프로젝트에 있으면 = 이 프로젝트는 이 오픈소스 라이선스하에 배포됩니다.(되어야 합니다.)
오픈소스 프로젝트 최상위 디렉토리에 위치합니다.
<추가문서>
- READEME.md : 프로젝트 코드의 목적, 사용 방법 설명 문서
- COPYRIGHT.txt : 저작권
- NOTICE.txt : 오픈소스 라이선스 개요
CONTRIBUTE 문서
프로젝트에 기여하고 싶을때 보는 문서 입니다.
해당 프로젝트에 기여하는 절차를 안내합니다. 너희들의 기여를 환영합니다.
pull request policy : 코드를 합칠때 요청
CODE OF CONDUCT
코드 시행 강령, 코드 사용규정
오픈소스 프로젝트(커뮤니티)에 참여하는 방법에 대한 표준 (ex. 모든 기여 존중, 서로존중, ...호의적, 포용적), 멤버간 이슈가 발생하면 해결 방안에 대해서도 적혀있을때가 있습니다.
커뮤니티 행동 지침과 비슷한 역할을 하는 문서입니다.
커뮤니티 건전성 체크리스트
깃허브는 커뮤니티에 대한 행동 기준을 굉장히 중요하다 생각하고 있습니다. 그리고 공정한 방식으로 즐겁게 생산하는 환경을 추구합니다.
커뮤니티 빌딩한다 = 오픈소스 프로젝트를 생성한다.
READEME.md
COPYRIGHT.txt
NOTICE.txt
CONTRIBUTING
CODE_OF_CONDUCT
파일들이 체크리스트에 들어갑니다.
repository의 insight탭에 활동수 및 활동날짜를 알 수 있습니다.
Commutity Standards탭에 체크리스트가 있습니다.
GitHub 이슈란?
프로젝트에서 발생할 수 있는 모든 활동에 대한 이슈
(기획, 작업, 추가, 버그, 개선, 질문 등)
1) Open : 진행 중, 계획(시작 전)
2) Close : 완료, 중단 (미진행)
gitHub가 템플릿을 만들어 주었습니다.
유사한 프로그램으로 Jira가 있습니다.
Pull Request란?
pull을 요청한다.
작성하던 branch가 기준 branch로 병합을 해도 되는지 묻습니다.
다시말하면 branch가 branch에게 요청을 하는것을 Pull Request입니다.
코드 리뷰는 pull request 과정에서 일어납니다.
Discussions(토론 게시판)
누구든 접근하여 토론을 할 수 있습니다. 운영은 오픈소스 프로젝트 팀이 하고있습니다.
