Skip to content

PR Management

Kijun Kwon edited this page Feb 12, 2024 · 1 revision

PR Rule

  • 1 Issue - 1 PR - 1 Commit을 원칙으로 함
    • 1 Issue - 1 PR의 경우, 정말 필요하면 여러개의 Issue resolve 가능
    • commit이 여러개라면, squash commit을 통해 하나의 커밋으로 만든 후 PR
  • 네이밍
    • [#{issue_nubmer}] {commit_subject}
      • e.g., [#8] Feat: add presentation api
    • commit 제목의 경우, _ 제거하여 작성

Make your PR small and focused

  • PR은 최대한 작고 응집된 형태로
    • 작다고 해서 집중된 PR은 아니고, 집중되어 있다고 해서 작은 PR은 아님
    • 두 조건의 교차점을 잘 파악하여, 적절한 크기의 PR을 올리자
  • Reference

Issue

  • 자유 형태
  • 어떤 이슈인지 명확히 알 수 있기만 하면 OK

PR Tempalte

## Motivation
-

## Key Changes
-

## To Reviewers
-

## Linked Issue
- resolved #
Clone this wiki locally