[Github] 깃허브 리포지토리 필수 파일 - README.md / .gitignore / LICENCE

  깃허브 리포지토리 생성 시 README.md / .gitignore / LICENCE 파일을 생성해 리포지토리를 효율적으로 관리할 수 있다. 위 주요 파일이 깃허브 리포지토리에서 어떤 역할을 수행하는지 알아보자.

 

1. README.md

  README.md 파일은 오픈소스 프로젝트에서 가장 먼저 확인할 수 있는 파일이다. 마크다운 문법을 사용해 간단한 소개 페이지를 제작할 수 있다. 보통 오픈소스를 활용할 수 있는 방법, 프로젝트에 관한 전반적인 핵심 소개가 포함되어있다.

# My First Repository

첫 번째 리포지토리입니다.

## Features

- 기능1
- 기능2

## Contributors

- FE: 개발자1, 개발자2
- BE: 개발자3, 개발자4

## Project Wiki

- 보다 더 자세한 프로젝트 안내를 위해 Wiki를 작성할 수 있다.
- (Wiki Link)

• Project Wiki - https://docs.github.com/ko/communities/documenting-your-project-with-wikis
• README - https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-readmes

 

2. gitignore

  .gitignore 파일은 리포지토리에 업로드하지 않을 파일들을 Git에서 제외시킬 수 있는 설정파일이다. 개인이 따로 관리해야할 secret token 이나 공유할 필요가 없는 log 파일 등을 제외 목록에 작성하면 git이 트래킹하지 않고 push하지 않는다.

 

  위와 같이 리포지토리를 생성할 때 미리 작성된 .gitignore template을 선택할 수 있다. 아래는 gitignore 파일의 작성 법과 예시이다.

• https://git-scm.com/docs/gitignore

 

3. LICENCE

  프로젝트의 라이센스를 표기한다. Public으로 공개된 리포지토리라고 해도 라이센스 여부에 따라 코드 사용이 가능할 수도 불가능 할 수도 있다.

 

  라이센스 또한 .gitignore과 마찬가지로 리포지토리 생성 시 미리 작성된 라이센스를 선택할 수 있다. 아래 GitHub Docs 사이트에서 올바른 라이센스를 선택해 적용하는 방법을 소개한다.

• https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/licensing-a-repository