COMMIT, ISSUE, PR 컨벤션 정의

[dididy]

Is your feature request related to a problem? Please describe.

지금껏 명확하지 않게 컨벤션을 지켜서 작업해왔는데 이를 명확하게 할 필요성이 생겼습니다.

Describe the solution you'd like

nhn/fe.javascript 를 확인해보면 COMMIT, PR, ISSUE, 각각에 대해 컨벤션을 정의해 두었습니다.

이 같은 형태로 컨벤션을 명확하게 정의하는게 좋을 것 같습니다.

COMMIT

• git-cz을 사용하여 git hooks를 걸어둔 상태이므로 conventional commit 형식을 매번 확인하고 선택할 수 있도록 해줍니다. 또한 commitlint가 적용되어있어 커밋메시지의 형식과 맞지 않는 경우 커밋이 반영되지 않도록 처리해 두었습니다.
• commitlint가 체크하지 못하는 부분에서 지켜야할 부분은 아래와 같습니다.
  • 제목은 명령조로 작성해야합니다.
  • 제목 끝에 . 을 붙이지 않습니다.
  • 제목과 본문은 한 줄 띄어서 작성합니다.
  • 제목 끝에 연관된 이슈번호를 붙입니다.
    • ex. feat: ISSUE_TEMPLATE을 추가한다 (#2)
  • 본문은 어떻게보다 무엇을, 왜에 맞춰 작성합니다.
  • ref: 좋은 git 커밋 메시지를 작성하기 위한 8가지 약속
    

ISSUE

• 제목은 ISSUE 성격에 맞게 자유롭게 합니다.
• 내용은 ISSUE_TEMPLATE에 맞춰서 작성합니다. 만약 템플릿과 작성해야할 이슈가 맞지 않는다면 원하는 형태로 변경합니다.

PR

• PR 제목 컨벤션도 commit 제목 컨벤션과 마찬가지로 명령조로 작성하고 맨 끝에 콤마를 사용하지 않도록 합니다.
  • class101-ui의 경우 커밋메시지를 PR 제목으로 사용하고 있는데 저희도 관심사에 맞춰 제목을 명령조로 작성하도록 합니다.
    • ex. ISSUE_TEMPLATE을 추가한다
• PR의 의도에 맞는 커밋만 추가하며 PR의 의도와 다른 작업은 추가적으로 issue와 PR을 생성합니다.
• 내용은 PR_TEMPLATE 에 맞춰서 작성합니다. 만약 템플릿과 작성해야할 이슈가 맞지 않는다면 원하는 형태로 변경합니다.

Describe alternatives you've considered

Additional context

[dididy]

witherview 리포지토리를 fork 받은 이후에 최신 상태 반영을 위해 해야 할 일(upstream 추가)

$ git clone <fork 받은 리포지토리>
$ git remote add upstream https://github.com/witherview/witherview_frontend.git

잘 추가되었는지 확인

$ git remote -v
---
origin	https://github.com/[GitHub 닉네임]/witherview_forntend.git (fetch)
origin	https://github.com/[GitHub 닉네임]/witherview_frontend.git (push)
upstream	https://github.com/witherview/witherview_frontend (fetch)
upstream	https://github.com/witherview/witherview_frontend (push)

[dididy]

컴포넌트 UI 개발

$ yarn storybook

코드 컨벤션

• 컴포넌트는 일반 함수로 내부 함수는 arrow function으로
• ...