Skip to content

Commit 2a2485c

Browse files
authored
[docs/#25] 컨벤션 문서 작성 (#26)
* docs: 깃허브 이슈 템플릿 수정 * docs: 커밋 컨벤션 작성 * docs: PR 컨벤션 작성
1 parent 4d6810e commit 2a2485c

12 files changed

Lines changed: 268 additions & 51 deletions
Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: 기능 개선
3+
about: '기존 기능의 개선 및 확장'
4+
title: "[IMPROVE] "
5+
labels: "✨ IMPROVE"
6+
assignees: ''
7+
8+
---
9+
10+
## ✨ 개선할 기능
11+
12+
<br>
13+
14+
## 🏷️ 도메인 (해당하는 것에 체크)
15+
- [ ] 📝 domain:post (게시글)
16+
- [ ] 👤 domain:user (사용자)
17+
- [ ] 🏢 domain:source (테크블로그 출처)
18+
- [ ] 🔍 domain:search (검색)
19+
- [ ] 🔔 domain:notification (알림)
20+
- [ ] 📊 domain:recommendation (추천)
21+
- [ ] 🌐 infra (인프라/배포)
22+
23+
<br>
24+
25+
## 📌 현재 상태 (AS-IS)
26+
<!-- 현재 어떻게 동작하는지 설명해주세요 -->
27+
28+
<br>
29+
30+
## 🎯 개선 방향 (TO-BE)
31+
<!-- 어떻게 개선할 것인지 설명해주세요 -->
32+
33+
<br>
34+
35+
## 💡 개선 이유
36+
<!-- 왜 개선이 필요한지 작성해주세요 -->
37+
38+
<br>
Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
---
22
name: 기능 구현
3-
about: '기능 설명 및 구현 '
4-
title: "[FEAT]"
5-
labels: "\U0001F6E0 FEAT"
3+
about: '새로운 기능 추가'
4+
title: "[FEAT] "
5+
labels: "🛠️ FEAT"
66
assignees: ''
77

88
---
@@ -13,3 +13,24 @@ assignees: ''
1313
- [ ]
1414

1515
<br>
16+
17+
## 🏷️ 도메인 (해당하는 것에 체크)
18+
- [ ] 📝 domain:post (게시글)
19+
- [ ] 👤 domain:user (사용자)
20+
- [ ] 🏢 domain:source (테크블로그 출처)
21+
- [ ] 🔍 domain:search (검색)
22+
- [ ] 🔔 domain:notification (알림)
23+
- [ ] 📊 domain:recommendation (추천)
24+
- [ ] 🌐 infra (인프라/배포)
25+
26+
<br>
27+
28+
## 📋 상세 설명
29+
<!-- 기능에 대한 자세한 설명을 작성해주세요 -->
30+
31+
<br>
32+
33+
## 💡 참고 사항
34+
<!-- 참고할 링크, 이미지 등이 있다면 추가해주세요 -->
35+
36+
<br>

.github/ISSUE_TEMPLATE/기능-수정.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 18 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,26 @@
11
---
22
name: 기타 수정
3-
about: '작은 부분 수정 '
4-
title: "[CHORE]"
5-
labels: "\U0001F3B5 CHORE"
3+
about: '설정, 의존성, 빌드 등 기타 수정'
4+
title: "[CHORE] "
5+
labels: "🎵 CHORE"
66
assignees: ''
77

88
---
99

10-
## 수정 부분과 이유
10+
## 🔧 수정 내용
1111

1212
<br>
13+
14+
## 📝 수정 이유
15+
16+
<br>
17+
18+
## 📦 관련 항목 (해당하는 것에 체크)
19+
- [ ] 의존성 업데이트
20+
- [ ] 설정 파일 변경
21+
- [ ] 빌드 스크립트 수정
22+
- [ ] Git 관련 설정
23+
- [ ] 환경 변수 변경
24+
- [ ] 기타
25+
26+
<br>
Lines changed: 33 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,12 +1,42 @@
11
---
22
name: 리팩토링
3-
about: 클린코드, 디렉토리 구조 변경
4-
title: "[REFACT] "
5-
labels: "\U0001F31F REFACT"
3+
about: '기능 변경 없는 코드 개선'
4+
title: "[REFACTOR] "
5+
labels: "🌟 REFACTOR"
66
assignees: ''
77

88
---
99

1010
## ✨ 리팩토링 할 부분
1111

1212
<br>
13+
14+
## 🏷️ 도메인 (해당하는 것에 체크)
15+
- [ ] 📝 domain:post (게시글)
16+
- [ ] 👤 domain:user (사용자)
17+
- [ ] 🏢 domain:source (테크블로그 출처)
18+
- [ ] 🔍 domain:search (검색)
19+
- [ ] 🔔 domain:notification (알림)
20+
- [ ] 📊 domain:recommendation (추천)
21+
- [ ] 🌐 infra (인프라/배포)
22+
23+
<br>
24+
25+
## 📌 현재 코드의 문제점
26+
<!-- 어떤 부분이 개선이 필요한지 설명해주세요 -->
27+
28+
<br>
29+
30+
## 🎯 리팩토링 방향
31+
<!-- 어떻게 개선할 것인지 설명해주세요 -->
32+
33+
<br>
34+
35+
## 💡 기대 효과
36+
- [ ] 가독성 향상
37+
- [ ] 성능 개선
38+
- [ ] 유지보수성 향상
39+
- [ ] 코드 중복 제거
40+
- [ ] 기타:
41+
42+
<br>

.github/ISSUE_TEMPLATE/문서-작업-.md

Lines changed: 0 additions & 12 deletions
This file was deleted.
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: 문서 작업
3+
about: '문서 작성 및 수정'
4+
title: "[DOCS] "
5+
labels: "📜 DOCS"
6+
assignees: ''
7+
8+
---
9+
10+
## 📜 작성/수정할 문서
11+
12+
<br>
13+
14+
## 📝 작업 내용
15+
- [ ]
16+
- [ ]
17+
- [ ]
18+
19+
<br>
20+
21+
## 💡 문서 종류 (해당하는 것에 체크)
22+
- [ ] README
23+
- [ ] API 명세서
24+
- [ ] 아키텍처 문서
25+
- [ ] 개발 가이드
26+
- [ ] 배포 가이드
27+
- [ ] 코드 주석
28+
- [ ] 기타
29+
30+
<br>
Lines changed: 39 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,39 @@
1+
---
2+
name: 배포 관련
3+
about: '인프라 및 배포 관련 작업'
4+
title: "[DEPLOY] "
5+
labels: "🚀 DEPLOY, 🌐 infra"
6+
assignees: ''
7+
8+
---
9+
10+
## 🚀 배포 작업 내용
11+
12+
<br>
13+
14+
## 🏗️ 작업 종류 (해당하는 것에 체크)
15+
- [ ] AWS 인프라 변경
16+
- [ ] Docker 설정 변경
17+
- [ ] CI/CD 파이프라인 수정
18+
- [ ] Nginx 설정 변경
19+
- [ ] 환경 변수 변경
20+
- [ ] 데이터베이스 마이그레이션
21+
- [ ] 기타
22+
23+
<br>
24+
25+
## 📋 작업 상세 설명
26+
27+
<br>
28+
29+
## ⚠️ 주의사항
30+
<!-- 배포 시 주의할 점이 있다면 작성해주세요 -->
31+
32+
<br>
33+
34+
## ✅ 체크리스트
35+
- [ ] 개발 환경 테스트 완료
36+
- [ ] 배포 계획 수립
37+
- [ ] 팀원 공유 완료
38+
39+
<br>
Lines changed: 37 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,37 @@
1+
---
2+
name: 버그 수정
3+
about: '버그 및 오류 수정'
4+
title: "[FIX] "
5+
labels: "🔧 FIX"
6+
assignees: ''
7+
8+
---
9+
10+
## 🐛 버그 내용
11+
<!-- 어떤 문제가 발생하는지 설명해주세요 -->
12+
13+
<br>
14+
15+
## 🏷️ 도메인 (해당하는 것에 체크)
16+
- [ ] 📝 domain:post (게시글)
17+
- [ ] 👤 domain:user (사용자)
18+
- [ ] 🏢 domain:source (테크블로그 출처)
19+
- [ ] 🔍 domain:search (검색)
20+
- [ ] 🔔 domain:notification (알림)
21+
- [ ] 📊 domain:recommendation (추천)
22+
- [ ] 🌐 infra (인프라/배포)
23+
24+
<br>
25+
26+
## ⚠️ 에러 로그 / 스크린샷
27+
<!-- 에러 로그나 스크린샷을 첨부해주세요 -->
28+
```
29+
에러 로그를 여기에 붙여넣기
30+
```
31+
32+
<br>
33+
34+
## 🎯 예상 원인
35+
<!-- 예상되는 원인이 있다면 작성해주세요 -->
36+
37+
<br>

.github/ISSUE_TEMPLATE/오류수정.md

Lines changed: 0 additions & 17 deletions
This file was deleted.

0 commit comments

Comments
 (0)