레포지토리란?
리포지토리(Repository)는 프로젝트의 파일과 변경 이력을 저장하는 공간
GitHub에서의 레포지토리
클라우드 상에 저장된 Git 버전 관리 시스템의 저장소 (코드, 문서, 이미지, 데이터 등을 저장)
- 프로젝트의 이전 상태로 되돌리기
- 협업하는 개발자들과 코드 변경 사항을 공유
- 프로젝트의 오픈소스화를 통해 다양한 기여
로컬레포지토리 vs 원격레포지토리
- 로컬 리포지토리: 내 컴퓨터에 저장된 레포지토리.
- 원격 리포지토리: GitHub와 같은 서버에 저장된 레포지토리.
레포지토리 생성하기
리포지토리 생성 버튼 클릭
리포지토리 설정
-
Repository name (리포지토리 이름)
간결하고 프로젝트의 목적을 잘 나타내는 이름을 선택
이름 규칙: 소문자사용, 밑줄(_)보다 하이픈(-)을 사용
-
Description (설명) (선택 사항)
프로젝트의 목적이나 특징을 간략히 설명
핵심 정보: 프로젝트 목적 + 주요 기술/언어 + 대상 사용자 + ...
-
Visibility (공개 여부)
Public: 누구나 리포지토리를 볼 수 있습니다.
Private: 초대된 사용자만 접근 가능합니다.
초기화 옵션 선택
-
Add a README file
프로젝트 소개와 설명을 작성하는 초기 README 파일을 생성
-
Add .gitignore
특정 언어(예: Python, Java, Kotlin)를 선택하면, 해당 언어의 일반적으로 버전 관리를 하지 않는 파일들을 자동으로 무시하도록 설정
-
Choose a license
내가 만들 프로젝트의 사용 및 배포 조건을 명확히 정의하는 라이선스 템플릿
오픈소스 프로젝트는 사용자가 소스 코드를 어떻게 사용할 수 있는지 명확히 규정해야 하며, 이때 라이선스가 필요
리포지토리 생성
설정을 완료한 뒤 페이지 하단의 Create repository 버튼을 클릭
README 파일 작성
README 파일이란?
프로젝트를 소개하고 사용법, 설치 방법, 기여 방법 등을 설명하는 문서
- 리포지토리의 최상단에 표시
- 다른 사용자들이 프로젝트의 정보를 빠르게 파악
- GitHub에서는 Markdown 언어(.md 확장자)를 사용해 작성
README 파일 작성법
(1) 간결하고 명확하게
중요한 정보는 한눈에 볼 수 있도록 간결하고 직관적으로 작성
(2) 프로젝트 목적과 기능 설명
프로젝트가 무엇을 하는지, 왜 유용한지를 설명
(3) 설치 및 실행 방법
사용자가 프로젝트를 쉽게 실행해볼 수 있도록 설치와 실행 가이드를 작성
(4) 사용 예제
프로젝트 사용법을 예제 코드나 스크린샷
(5) 라이선스 및 기여 방법
프로젝트의 라이선스 정보를 명시
README 파일 템플릿
https://velog.io/@im349412/README-%ED%8C%8C%EC%9D%BC-%ED%85%9C%ED%94%8C%EB%A6%BF
로컬에서 README 작성하기
로컬 환경에서 README.md 파일을 직접 작성한 후 Git을 사용해 업로드가능
echo "# My Project" > README.md
git add README.md
git commit -m "Add README file"
git push origin main