Skip to content

Commit 5b20f32

Browse files
committed
chore: github 이슈 템플릿 생성
1 parent b741c0e commit 5b20f32

3 files changed

Lines changed: 147 additions & 0 deletions

File tree

.github/ISSUE_TEMPLATE/bug.md

Lines changed: 50 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,50 @@
1+
---
2+
name: Bug
3+
about: 백엔드 버그를 제보합니다.
4+
title: "[BUG] "
5+
labels: bug
6+
assignees: ""
7+
---
8+
9+
# Bug
10+
11+
## 버그 설명
12+
13+
- 발생한 문제를 간단히 설명해주세요.
14+
15+
## 재현 방법
16+
17+
1.
18+
2.
19+
3.
20+
21+
## 기대 동작
22+
23+
- 원래 기대한 동작을 적어주세요.
24+
25+
## 실제 동작
26+
27+
- 실제로 발생한 동작을 적어주세요.
28+
29+
## 요청 정보
30+
31+
- 엔드포인트:
32+
- HTTP Method:
33+
- 요청 파라미터 또는 바디:
34+
- 인증 여부:
35+
36+
## 응답 정보
37+
38+
- 상태 코드:
39+
- 응답 바디:
40+
- 에러 메시지:
41+
42+
## 발생 환경
43+
44+
- 로컬, 개발, 운영:
45+
- 관련 DB 데이터:
46+
- 외부 API 또는 연동 시스템:
47+
48+
## 추가 정보
49+
50+
- 로그, 스크린샷, API 요청/응답 예시, 관련 이슈 등을 첨부해주세요.

.github/ISSUE_TEMPLATE/feature.md

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
---
2+
name: Feature
3+
about: 백엔드 기능 추가 또는 개선 사항을 제안합니다.
4+
title: "[FEAT] "
5+
labels: enhancement
6+
assignees: ""
7+
---
8+
9+
# Feature
10+
11+
## 기능 설명
12+
13+
- 추가하거나 개선하려는 기능을 설명해주세요.
14+
15+
## 배경 및 목적
16+
17+
- 이 기능이 필요한 이유와 해결하려는 문제를 적어주세요.
18+
19+
## 요구 사항
20+
21+
- [ ]
22+
- [ ]
23+
- [ ]
24+
25+
## API 설계
26+
27+
- 엔드포인트:
28+
- HTTP Method:
29+
- 요청 파라미터 또는 바디:
30+
- 응답 데이터:
31+
- 에러 응답:
32+
33+
## 데이터 및 도메인
34+
35+
- 관련 엔티티:
36+
- DB 변경 필요 여부:
37+
- 마이그레이션 필요 여부:
38+
- 외부 API 또는 연동 시스템:
39+
40+
## 보안 및 검증
41+
42+
- 인증 필요 여부:
43+
- 권한 조건:
44+
- 입력 값 검증:
45+
- 예외 처리:
46+
47+
## 완료 조건
48+
49+
- [ ] 요구 사항이 구현되었습니다.
50+
- [ ] 성공, 실패, 예외 케이스가 처리되었습니다.
51+
- [ ] API 명세 변경 사항이 공유되었습니다.
52+
- [ ] 관련 테스트 또는 수동 검증이 완료되었습니다.
53+
54+
## 참고 자료
55+
56+
- 기획서, API 문서, 관련 이슈 등을 첨부해주세요.

.github/PULL_REQUEST_TEMPLATE.md

Lines changed: 41 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,41 @@
1+
# Pull Request
2+
3+
## 작업 개요
4+
5+
- 이 PR에서 해결한 문제나 구현한 기능을 간단히 설명해주세요.
6+
7+
## 변경 사항
8+
9+
-
10+
-
11+
-
12+
13+
## 관련 이슈
14+
15+
- Closes #
16+
17+
## 테스트
18+
19+
- [ ] 로컬에서 기능 동작을 확인했습니다.
20+
- [ ] 빌드 또는 테스트가 통과했습니다.
21+
- [ ] 변경된 API의 성공, 실패 케이스를 확인했습니다.
22+
- [ ] 요청 값 검증과 예외 처리를 확인했습니다.
23+
24+
## 체크리스트
25+
26+
- [ ] 불필요한 로그, 주석, 디버깅 코드를 제거했습니다.
27+
- [ ] API 명세 변경 사항을 문서화했거나 공유했습니다.
28+
- [ ] 인증, 인가, 입력 검증 영향을 확인했습니다.
29+
- [ ] DB 스키마, 마이그레이션, 초기 데이터 변경 여부를 확인했습니다.
30+
- [ ] 환경 변수나 배포 설정 변경이 있다면 문서화했습니다.
31+
32+
## API 변경 사항
33+
34+
- 추가 또는 변경된 엔드포인트:
35+
- 요청 예시:
36+
- 응답 예시:
37+
- 에러 응답:
38+
39+
## 리뷰 포인트
40+
41+
- 리뷰어가 특히 확인해야 할 부분을 적어주세요.

0 commit comments

Comments
 (0)