Skip to content

컨벤션

강근우 edited this page Nov 23, 2020 · 7 revisions

Commit

[iOS] Feat : ⚡ Init dododoo #34

[WEB] Fix : ⚡ Something blah blah # 35

제목 : 영어

컨텐트 : 한국어
######## 본문은 한 줄에 최대 72 글자까지만 입력 ########################### -> |
# [플랫폼]<타입> 제목
# [iOS|Web] Feat : :zap:️ 기능 (새로운 기능) #이슈번호
# [iOS|Web] Fix : :fire: 버그 (버그 수정) #이슈번호
# [iOS|Web] Refactor: :rainbow: 리팩토링 #이슈번호
# [iOS|Web] Style : :high_heel:스타일 (코드 형식, 세미콜론 추가: 비즈니스 로직에 변경 없음) #이슈번호
# [iOS|Web] Docs : :books: 문서 (문서 추가, 수정, 삭제) #이슈번호
# [iOS|Web] Test : :joystick:  테스트 (테스트 코드 추가, 수정, 삭제: 비즈니스 로직에 변경 없음) #이슈번호
# [iOS|Web] Chore : :package: 기타 변경사항 (빌드 스크립트 수정 등) #이슈번호
# [iOS|Web] Deploy : :airplane:  배포 관련 #이슈번호
# —————————
#     제목은 명령문 영어로 적자.
#     제목 끝에 마침표(.) 금지
#     제목과 본문을 한 줄 띄워 분리하기
#     본문은 한글로 적는다.
#     본문은 “어떻게” 보다 “무엇을“, “왜”를 설명한다.
# ————————— 

---
name: Feature request
about: Suggest an idea for this project
title: ''
labels: ''
assignees: ''

---

## 🍞 Feature
 
| Name             | about | title | labels | assignees |
| ---------------- | -------- | -------- | -------- | -------- |
| Feature Request  | Suggest an idea for this project  |   |    |    |

---

## 🍞 설명

Github 이슈 설명
<br/>

## 🥞 체크리스트

> 구현해야하는 이슈 체크리스트

- [ ] 체크 사항 1
- [ ] 체크 사항 2
- [ ] 체크 사항 3
- [ ] 체크 사항 4
<br/>

## 🥞 주의 사항

> 이슈를 구현할 때 유의깊게 살펴볼 사항

- 주의 사항 1
- 주의 사항 2

<br/><br/>
---
name: Bug report
about: Create a report to help us improve
title: ''
labels: ''
assignees: ''

---

| Name       | about                              | title | labels | assignees |
| ---------- | ---------------------------------- | ----- | ------ | --------- |
| Bug report | Create a report to help us improve |       |        |           |

<br/>

### 🍞 Current behavior (bug)

Write here

<br/>

### 🍞 Expected behavior (correct)

Write here

<br/>

### 🥞 버그 재현방법

1. Write here
2. Write here

Pull Request

PR 제목
[플랫폼] Update View Controller (영어)

### 🍞 Issue Number 

close: #
<br/>

### 🥞 작업 내역

> 구현 내용 및 작업 했던 내역

- [ ] 작업 내역 1
- [ ] 작업 내역 2
- [ ] 작업 내역 3
- [ ] 작업 내역 4
      <br/>

### 🍞 변경사항

- 의존성 목록
  <br/>

### 🍞 새로운 기능

- 기능 목록
  <br/>

### 🍞 작업 유형

- [x] 신규 기능 추가
- [ ] 버그 수정
- [ ] 리펙토링
- [ ] 문서 업데이트
  <br/>

### 🥞 체크리스트

- [ ] Merge 하는 브랜치가 올바른가?
- [ ] 코딩컨벤션을 준수하는가?
- [ ] PR과 관련없는 변경사항이 없는가?
- [ ] 내 코드에 대한 자기 검토가 되었는가?
- [ ] 변경사항이 효과적이거나 동작이 작동한다는 것을 보증하는 테스트를 추가하였는가?
- [ ] 새로운 테스트와 기존의 테스트가 변경사항에 대해 만족하는가?
  <br/>

### 🥞 PR 특이 사항

> PR을 볼 때 주의깊게 봐야하거나 말하고 싶은 점

- 특이 사항 1
- 특이 사항 2

<br/><br/>

깃 전략

✅ git flow

✅ 브랜치를 PR할 때 최소 1명의 리뷰를 받는다.

✅ feature 브랜치에서 작업한 내용은 로컬에서 별도 작업 없이 원격으로 push 해서 깃헙에서 컨플릭을 해결한다.

✅ 포크 여부는 자율

브랜치 구성

master - 실제 완성 코드 / 배포가 이루어지는 브랜치
dev - ios & web 브랜치 merge <default>
dev_ios
dev_web
feature/web|ios/function_something

🦜 실시간 번역 메신저

💫 서비스

📌 기획서

🤙 규칙

📃 컨벤션

📝 Documents

⚙️ 기술 스택

Clone this wiki locally