[GitHub] 깃허브로 토이 프로젝트 시작하기

---

토이 프로젝트를 시작하기 전에...

 

 깃허브에서 commit, push 기능만 사용하고 계시진 않나요? 토이 프로젝트를 진행하면서 이용하면 너무 좋을 것 같은 기능들을 소개하기 위해 글을 작성하게 되었습니다😄 GitHub에서 제공해주는 기능들을 이용하였기 때문에 특정 언어에 종속되지 않고 어떤 언어로 사용하는 프로젝트든 이용 가능합니다.

 

목차는 아래와 같습니다.

1. Main  - 프로젝트 소개하기
   
   • About 
   • README.md
2. Issues - 할 일 정리하기
3. Pull Requests - 코드 리뷰 문화 도입하기
4. Discussions - 프로젝트 전용 커뮤니티 만들기
5. Projects - 편리하게 일정 관리하기
   
   

 

---

1. Main

예제 링크 - 우테코 학습 기록용 레포

 

About

• 프로젝트에 대한 부가 설명 추가
• 오른쪽의 톱니바퀴 - 여러가지 옵션 선택

프로젝트 메인 화면

설정창

설정 변경 후 보이는 화면

 

README.md

• 해당 파일을 생성하면 프로젝트 클릭 시 파일 내용을 보여줌
• About에서 지정한 것보다 더 상세히 레포지토리에 대해 설명 (이미지 등 추가 가능)
• 프로젝트 최상위 디렉토리에 README.md 파일 추가
• README.md는 마크다운 문법을 사용

프로젝트 클릭 시 보이는 화면

 

---

2. Issues

예제 링크 - 줍줍 프로젝트

 

• 작업에 대한 계획을 세우는 역할
• 프로젝트 담당자 외의 다른 사람들도 피드백, 개선 사항 등 입력 가능
• 깃허브에서 트래킹하기 쉬워짐
• 라벨, 프로젝트, 마일스톤 설정 가능

 

Issues 화면

issue 상세 화면

---

3. Pull Requests

예제 링크 - 줍줍 프로젝트

 

• 레포지토리의 변경 사항을 다른 사람에게 알림 가능
• PR이 열리면 변경 사항을 논의한 후, 합병하고자 하는 브랜치에 코드를 합병할지 결정
• 코드 리뷰 진행 가능
• Issues처럼 라벨, 프로젝트, 마일스톤, 이슈 설정 가능
• 👉 PR 올리는 방법: https://yeonyeon.tistory.com/158

[GitHub] Pull Request와 코드리뷰

 

PR 목록

---

4. Discussions

 

• 프로젝트를 위한 커뮤니티
• 질문을 주고받거나 업데이트를 공유하고 대화를 나누는 등 자유롭게 사용

 

🔻 Discussions 활성화하는 방법

Settings - Features - Discussions

 

discussion 목록

 

---

5. Projects

예제 링크 - 줍줍 프로젝트

 

• 칸반 보드 형태로 작업 구상 가능
• 구현할 기능이나 할 일 등의 우선 순위를 정하는데 도움
• issue나 PR 등을 등록해두는 경우 해당 작업이 closed/merged 되면 Project Board에서도 자동으로 반영
• 자유롭게 카드나 할 일 등을 등록 가능

 

project 목록

project 상세 - 자유롭게 할 일을 이동할 수 있음

 

 

---

참고

• https://docs.github.com/en