SYEON10 / LearningGithub

깃/깃허브를 시행착오로 겪어보는 레포지토리입니다.

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

LearningGithub

깃허브를 시행착오로 겪어보는 레포지토리입니다.

🖥GOAL

깃허브의 기능을 가능한대로 많이 사용해보기 위해 만들어졌습니다. 학습하는대로 README에 추가합니다. 연결된 하이퍼링크는 전부 제 계정이 아닙니다.

📑README.md

  • README 작성하기 README를 작성하는 방법부터 마크다운 언어 사용방법까지 나와있다.

코드 컨벤션

코드를 쓸 때 정하는 규칙이다. 이름 규칙, 커밋 규칙, 등 코드 작성 시 사용되는 모든 규칙이다. 이는 모두 개발팀에서 정해나가기 마련이다. 그리고 이 과정은 단번에 진행할 수 없고, 적용까지 약 한달에서 그 이상 걸릴 가능성이 높다. 한두달 짧게 진행되는 토이 프로젝트에서 커밋 규칙 외 사항들에 집착하지 말자. 지켜지는 경우도 드물고 효과를 체감하는 건 더욱 어렵다. 사실 한두달짜리는 커밋 헤더 잘 달고 제목만 잘 쓰면 크게 작업에 지장 없더라!

Overview

Overview 에서 내가 가진 기술들, 내가 어떤 프로젝트를 했는지, 등을 아름답게 보여줄 수 있다.

PR

PR의 내용, 간격, 템플릿을 다룬다.

Issue

작업 시 발생하는 다양한 문제들을 다룬다. 주로 코드와 직/간접적 영향이 있는 경우나 일정에 같이 넣어야 하는 문제를 주로 Issue 에서 처리한다. 레이블/마일스톤을 통해 조금 더 효율적으로 문제를 분류하고 이슈들을 모아 따로 이슈를 만듦으로 이슈를 더 간결하게 정리할 수 있다. 마일스톤으로 진행도까지 확인할 수 있다. 그리고 이를 프로젝트에 연결하여 Board, Schedule, Table의 View로 확인할 수 있다.

사실 코드를 노션 기능으로 관리한다고 생각하면 편하다. 그런데 이제 플랫폼을 옮기고 링크를 걸 필요가 없는!

Project

Issue와 마일스톤을 가시적으로 볼 수 있다.

Discussion

회의록, Q&A, 투표, 아이디어 제시, 정보 공유 등 당장 해결할 필요도 없고, 일정에 들어가야 하는 것도 아닌데, 우리가 함께 나누었으면 좋겠는 것들이 있다.

그럴 때 Dicsussion 을 쓰자!

Wiki

우리가 최종적으로 정리한 내용, 컨벤션 정리, 만약 라이브러리라면 이걸 어떻게 사용하면 좋은지, 등... 정리해놓은 문서 집합이라고 보면 된다. 나중에 이것도 README에서 Wiki로 옮겨야겠다!

Action

CI/CD

About

깃/깃허브를 시행착오로 겪어보는 레포지토리입니다.