슉 기획

@VERO
Created Date · 2023년 06월 27일 11:06
Last Updated Date · 2023년 06월 27일 11:06

개발 컨벤션 좋아보이는 거 모음

Issue 템플릿

  • 버그 이슈 템플릿
## 🤷 버그 내용

## ⚠ 버그 재현 방법
1.
2.
3.

## 📸 스크린샷

## 👄 참고 사항

by dallog
## 버그 기능
- 페이지나 기능을 적습니다.

### 버그 상황 재연
- 어떤 상황에서 버그가 발생하는지 적습니다.

### 기대 동작
- 원래 기대하던 정상 동작에 대해 작성합니다.

### 현재 동작
- 기대하던 동작에 반해 지금 문제가 되는 동작을 작성합니다.

by zzimkkong
### QA 환경 : 

### 현상: 

### 재현 과정 : 

### 예상되는 원인: 

### 스크린샷:

by jujeol-jujeol
  • 피쳐 이슈 템플릿
## 🤷 구현할 기능

## 🔨 상세 작업 내용

- [ ] To-do 1
- [ ] To-do 2
- [ ] To-do 3

## 📄 참고 사항

## ⏰ 예상 소요 기간

by dallog
[FE | BE] 명사형으로 작성
### 설명

### 진행상황
- [ ] 진행사항1
- [ ] 진행사항2

### 주의사항

by jujeol-jujeol

PR 템플릿

## 작업 내용

## 스크린샷

## 주의사항

Closes #{이슈 번호}

by dallog
## 구현 기능
- 구현한 기능을 적습니다.

## 논의하고 싶은 내용
- 논의할 내용을 적습니다.

## 공유하고 싶은 내용
- 학습한 내용, 공유할 내용 등을 적습니다.
- 위키에 작성했다면 링크 첨부, 없는 경우 삭제

## 기타
- 기타 추가할 내용이 있다면 추가합니다.
- 없는 경우 삭제

Close #이슈번호

by zzimkkong
## resolve #issue number

### 설명
- 프론트의 경우 화면 작업일 때 캡쳐본 포함하기

### 기타

by jujeol-jujeol
[ALL/FE/BE] 작업 진행 내용 간단명료하게

## 📌 관련 이슈
<!-- 이슈 번호를 적어주세요
closed #issue_number를 적어주세요-->

## ✨ 작업 내용
<!-- 어떤 작업을 했는지 설명해주세요 -->

## 📷 스크린샷 (선택)
<!-- 스크린샷 필요하면 첨부해주세요 --> 

## 🔍 참고 사항
<!-- PR을 리뷰할 때 참고할 사항이 있으면 적어주세요 -->
  • RCA 룰 by 주노

    • 각각의 코멘트의 접두에 R, C, A를 붙이면서 리뷰를 진행하는 방식이다.
    • R (Request Changes) : 적극적으로 반영을 고려해주세요
    • C (Comment) : 웬만하면 반영해주세요
    • A (Approve) : 반영해도 좋고, 넘어가도 좋습니다. 사소한 의견입니다.
  • reviewer가 1명 이상 approve 하지 않았을 경우에는 merge block 하기

코드 컨벤션

Git Branch 전략

  • main
    • 실제 프로젝트 사용자들이 볼 배포 브랜치
  • develop
    • 개발 총괄 브랜치
    • main 에서 파생, 기능 개발 후 main에 반영
    • feat/issue-number
      • issue 단위의 기능 개발 브랜치
      • develop 에서 파생, 기능 개발 후 develop에 반영
    • fix/issue-number
      • issue 단위의 버그 수정 브랜치
      • develop 에서 파생, 버그 수정 후 develop에 반영
  • hotfix
    • main 에서 파생, 버그 수정 후 main에 반영

Commit 컨벤션

  • feat: 기능 개발
  • docs: 문서 관련 작업
  • refactor: 기능 변경 없이 전반적 코드 구조 변경 (Ex. 필드 이름 변경 등)
  • chore: 파일 내부가 아닌 파일 자체에 대한 변경 (Ex. 폴더 이동 / 변경, 파일 이름 변경, 파일 삭제)
  • style: 코드 컨벤션 관련 작업
  • test: 테스트 코드 관련 작업
  • fix: 버그 수정
  • design: 마크업 관련 수정
  • config: 외부 라이브러리 관련 추가 및 설정