오픈소스를 만들기 위해 작성하는 문서들은 종류가 다양한데요.
대부분 문서들은 md 파일이나 txt 파일로 생성을 합니다.
오픈소스를 생성한다면 기본문서는 필수로 작성을 해야 하고 추가적인 문서는 선택에 따라 작성을 하면 되는 것 같습니다.
- LICENSE(기본)
- 오픈소스 라이선스 전체문서 명시를 하는 문서로 이 파일이 존재한다면 해당 프로젝트는 라이선스를 갖고 있다는 의미를 내포합니다.
- 보통 위치는 최상의 디렉토리에 있습니다. 관리하는 라이선스가 많다면 따로 관리하는 경우도 있습니다.
- READEME(추가)
- 보통 사용설명서로 작성되는 README에도 라이선스 관련 문서를 작성하기도 합니다.
- 일반적인 프로젝트 코드 목적 뿐만아니라 사용 시 주의사항도 적을 수 있기 때문이라 생각됩니다.
- COPYRIGHT (추가)
- 카피라이트는 말그대로 저작권에 포커싱 되어있습니다.
- NOTICE (추가)
- 오픈소스의 라이선스에 대한 개요를 작성해 주는 곳으로 보통 어떤 오픈소스를 사용했다 정도 설명이 되면 되는 것 같습니다.
- CONTRIBUTING (추가)
- 프로젝트에 어떤 방식으로 기여할 수 있는지 설명하는 문서로 기여 절차에 대해 설명되어 있는 문서입니다.
- CODE_OF_CONDUCT (추가)
- 프로젝트 기여자들을 위한 윤리강령으로 참여하는 방법에 대한 표준을 말합니다.
'개발지식' 카테고리의 다른 글
개발과 명세1 (0) | 2024.03.20 |
---|---|
Contributor와 Contribution (0) | 2024.02.20 |
오픈소스와 라이선스 (0) | 2024.02.14 |
메모리 구조와 메모리 할당 (0) | 2024.01.22 |
컴파일 언어와 스크립트 언어 (0) | 2024.01.22 |