[개발/Git] Git Repository 생성 (.gitignore, license, README 작성)

1. Repository 생성하기

 Git을 사용하기 위해선 Github에서 repository를 clone해서 내 로컬 저장소로 가져와야 한다. 때문에 일단 Github에서 repository를 생성하는 방법을 알아보도록 하겠다.

 

1) 생성 메뉴 찾기

우측 상단에 '+' 버튼을 누르면 메뉴창이 나온다 여기서 "New repository"를 선택하면 된다.

2) Repository 세팅하기

(1) 이름 설정

 Repository의 이름과 이 repo가 무엇을 하는지 설명을 쓸 수 있다. 좋은 repo의 이름은 간결해야 하며, 보는 순간 이게 무슨 역할을 하는지 알 수 있어야 한다.

 

(2)  공개 범위 설정

 - public : 누구나 이 repository를 볼 수 있음.

 - private :  이 repository를 볼 수 있는 사람을 선택할 수 있음

 

 사실 public으로 해도 아무도 내 repo 안본다. 그리고 공부한 흔적을 남기기 위해선 public으로 하는 것을 추천한다.

2. README file 지정, .gitignore 파일 추가, 라이센스 설정

1) README 파일

 프로젝트에 대한 설명, 사용 방법 등을 담은 파일로 소프트웨어와 함께 배포된다.

README 파일에 추가되어야 하는 항목

• 프로젝트 요약 설명
• 목차
  • 설치 방법
  • 시작하는 방법
  • 특징
  • 기술 스택
  • 프로그램이 사회에 기여하는 부분(선택)

2) .gitignore 파일

Git의 repository나 staging area에 추가되지 않아도 되는 파일을 정의하여 해당 파일이 추적되지 않도록 함.

ex) 실행 결과를 result.txt 파일로 만들어내는 프로그램의 경우 result.txt는 프로그램이 실행될때마다 변하고, 프로그램의 실행에 영향을 주지 않기 때문에 .gitignore에 추가하여 해당 파일을 추가하지 않도록 한다.

 

.gitignore 파일 작성하기

1. 확장자 무시
   • *.java : java 확장자의 파일 모두 지정
2. 파일명 무시
   • keyfile.* : 파일 이름이 keyfile인 파일 모두 지정
3. 디렉토리 무시
   • hidden/** : hidden 디렉토리에 있는 모든 파일 지정

 

아래 사이트에서 사용하는 OS, IDE, 언어를 추가하면 gitignore파일을 생성해준다.

https://www.toptal.com/developers/gitignore

gitignore.io

 

3) License 설정

 본인이 창작한 오픈소스 소프트웨어에 대한 사용 권한을 설정하는 것이다.

• MIT License
  • 저작권 아예 없기 때문에 영리적 사용도 가능함
• Apache License 2.0
  • 누구나 자유롭게 사용할 수 있으며 본인이 개발한 코드에 대한 특허권을 주장할 수 있음
• GNU General Public License v3.0
  • 한 줄이라도 해당 라이센스가 적용된 소스코드 사용 시 GPL을 따라야 한다는 의무사항이 존재함

---

3. Repository 생성 완료

여기까지 모든 과정을 마쳤다면 repository가 성공적으로 생성 되었을 것이다.