Github Rules

✨ Issue Management

• 이슈 생성시 미리 작성해둔 Issue Template을 바탕으로 이슈를 작성한다.
  • Algorithm Theme Issue Template
    • 알고리즘 주제에 맞춘 Issue Template
    • 알고리즘 주제에 맞춰 이슈를 생성한다
  • General Issue Template
    • 알고리즘 주제 외 일반적인 이슈 생성시 사용하는 Issue Template
• Issues 탭에서 New Issue 버튼 클릭시 아래와 같이 템플릿을 선택할 수 있다.
• 이슈번호는 커밋 메세지에서 활용된다.

✨ Git Workflow

• Conflict를 최소화하기 위한 Git 작업 순서
  • 내 레퍼지토리에서의 작업
    • 우선 원본 레퍼지토리(devyeony/algorithm-study)를 Fork 해온 상태라고 가정한다.
      • 원본 레퍼지토리가 아닌 Fork하여 생성된 내 레퍼지토리(내 깃허브 아이디/algorithm-study)를 Clone 해야 한다.
      • 원본 레퍼지토리를 리모트 레퍼지토리로 추가해야 한다.
        • 아래 포스팅을 참고한다.
          • Fork 한 repository 최신으로 동기화하기(Git Command 사용)
          • Fork 한 repository 최신으로 동기화하기(Sourcetree 사용)
    • 원본 레퍼지토리(devyeony/algorithm-study)를 Fetch 하여 변경사항을 가져온다.
    • 내 레퍼지토리 main 브랜치에 원본 레퍼지토리 main 브랜치의 변경사항을 Merge해서 반영 후 Push
    • 내 레퍼지토리 main 브랜치에 Checkout 된 상태로 코드 작성 후 Commit, Push
    • 원본 레퍼지토리를 Fetch 하여 그 사이에 생긴 변경사항을 가져온다.
    • 내 레퍼지토리 main 브랜치에 그 사이에 생긴 원본 레퍼지토리 main 브랜치의 변경사항을 Merge해서 반영 후 Push
  • 원본 레퍼지토리에 내 레퍼지토리의 변경사항 반영
    • 우선 내 레퍼지토리 main 브랜치에 원본 레퍼지토리의 변경사항이 잘 반영되어 있는지 확인하고 싱크를 맞춘다.
      • 변경사항이 잘 반영되어 있는 경우
      • 변경사항이 반영되어 있지 않은 경우(이 때 Fetch upstream 클릭 - Fetch and merge 클릭으로 원본 레퍼지트로 main 브랜치의 내용을 반영할 수 있음)
    • Pull Request를 작성한다.
      • 나의 깃허브 레퍼지토리에서 Pull Requests 탭을 클릭 - New pull request 클릭
      • Create pull request 클릭
      • PR 템플릿에 맞춰 다음의 내용을 작성한 후 Create pull request 를 클릭
        • 제목 - 알고리즘 주제 : ##
        • ❓ Description - ##과 관련된 알고리즘 문제풀이 PR
        • 🖍️ Changes details - (선택) 변경사항을 상세하게 기술하고자 할 때 추가적으로 쓴다.
        • 📷 Screenshot - (선택) 필요시 스크린샷을 첨부한다.
        • Reviews - 자기 자신을 제외한 팀원들
        • Assignees - 자기 자신
        • Labels - problem solving

✨ Commit Message Style Guide

• 커밋 메세지 작성시 제일 앞에 알고리즘 주제와 관련된 이슈번호를 붙이며 알고리즘 문제 사이트명, 문제번호, 문제명을 함께 기입한다.
• (선택사항) 필요시 본문을 작성할 수 있다.

예시1)

#2 - LeetCode : 60. Permutation Sequence

예시2)

#2 - 백준 : 2869. 달팽이는 올라가고 싶다

- 본문 내용1
- 본문 내용2
- 본문 내용3