Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[Docs] GitHub Issue 및 PR Template 설정 #37

Merged
merged 6 commits into from
Jul 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
44 changes: 44 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
name: "bug"
description: "버그 발생 시"
labels: "bug"
body:
- type: textarea
attributes:
label: 🐞버그 설명
description: 버그에 대한 설명을 작성해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: 📄 버그 로그
description: 로그가 있으면 입력해 주세요.
render: shell
validations:
required: false
- type: textarea
attributes:
label: 🌏 버그 발생 환경
description: 버그가 발생한 환경에 대해 작성해 주세요.
placeholder: |
OS: macOS
validations:
required: true
- type: textarea
attributes:
label: ✅ 버그 재현 방법
description: Given-When-Then 형식으로 버그를 재현할 수 있는 방법에 대해 작성해 주세요.
validations:
required: false
- type: textarea
attributes:
label: 📎 참고 자료
description: 발생한 버그에 대한 참고 자료가 있다면 작성해 주세요.
validations:
required: false
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 버그를 해결하기 위한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/deploy.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "deploy"
description: "배포 시"
labels: "deploy"
body:
- type: textarea
attributes:
label: 📄 작업 설명
description: 배포에 대한 설명을 작성해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: ✅ 작업 내용
description: 배포에 대한 Tasks를 작성해 주세요.
placeholder: 최대한 세분화 해서 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 📎 참고 자료
description: 배포에 대한 참고 자료가 있다면 작성해 주세요.
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 배포를 위한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/env.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "env"
description: "환경 설정 시"
labels: "env"
body:
- type: textarea
attributes:
label: 📄 작업 대상
description: 작업할 환경 설정에 대해 설명해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: ✅ 작업할 내용
description: 환경 설정에 대한 Tasks를 작성해주세요.
placeholder: 최대한 세분화 해서 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 📎 참고 자료
description: 환경 설정에 대한 참고 자료가 있다면 작성해 주세요.
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 환경설정을 추가하기 위한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/feat.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "feat"
description: "기능 추가 시"
labels: "feat"
body:
- type: textarea
attributes:
label: 📄 작업 대상
description: 작업할 기능에 대한 설명을 작성해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: ✅ 작업 내용
description: 기능 구현에 대한 Tasks를 작성해 주세요.
placeholder: 최대한 세분화 해서 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 📎 참고 자료
description: 새로운 기능에 대한 참고 자료가 있다면 URL을 작성해 주세요.
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 새로운 기능을 추가하기 위한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
36 changes: 36 additions & 0 deletions .github/ISSUE_TEMPLATE/meeting.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
name: "meeting"
description: "회의 시"
labels: "meeting"
body:
- type: textarea
attributes:
label: 📝 설명
description: 회의 주제에 대한 설명을 작성해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: 🙋🏻 참가 인원
validations:
required: true
description: 회의에 참여할 인원 및 역할(진행자, 서기)을 작성해 주세요.
- type: textarea
attributes:
label: ⏰ 회의 시간
validations:
required: true
description: 회의 날짜와 시간을 입력해 주세요.
- type: textarea
attributes:
label: ✅ 회의 안건
description: 해야 하는 일에 대한 Tasks를 작성해 주세요.
placeholder: 최대한 세분화 해서 적어 주세요!
validations:
required: true
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 회의를 진행하는데 필요한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
28 changes: 28 additions & 0 deletions .github/ISSUE_TEMPLATE/refactor.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
name: "refactor"
description: "리팩터링 시"
labels: "refactor"
body:
- type: textarea
attributes:
label: 🛠️ 작업 대상
description: 리팩터링에 해야할 범위를 설명해 주세요.
placeholder: 자세히 적을수록 좋습니다!
validations:
required: true
- type: textarea
attributes:
label: ✅ 작업 내용
description: 리팩터링을 할 부분에 대한 Tasks를 작성해 주세요.
placeholder: 최대한 세분화 해서 적어주세요!
validations:
required: true
- type: textarea
attributes:
label: 📎 참고 자료
description: 리팩터링에 대한 참고 자료가 있다면 작성해 주세요.
- type: textarea
attributes:
label: ⏰ 추정 시간
description: 리펙토링을 위한 추정 시간(비관적 추정, 낙관적 추정)에 대해 작성해주세요.
validations:
required: true
21 changes: 21 additions & 0 deletions .github/PULL_REQUEST_TEMPLATE.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,21 @@
<!-- 반드시 BE/FE 라벨과 리뷰어를 등록해주세요! -->

## 작업 대상
<!-- 작업한 대상을 자세히 설명해주세요. -->

## 📄 작업 내용
<!-- 작업한 내용을 간단히 요약해주세요. -->

## 🙋🏻 주의 사항
<!-- 리뷰어를 위해 복잡하거나 중요한 코드를 명시해주세요. -->

## 스크린샷
<!-- 필요한 경우 이해를 돕기위해 스크린샷을 올려주세요. -->

## 📎 관련 이슈
<!-- merge 시 close할 issue 번호를 입력해주세요. -->

<!-- closed #번호 -->

## 레퍼런스
<!-- 작업 시 참고했던 문건의 URL을 남겨주세요 -->
41 changes: 41 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
HELP.md
.gradle
build/
!gradle/wrapper/gradle-wrapper.jar
!**/src/main/**/build/
!**/src/test/**/build/

### STS ###
.apt_generated
.classpath
.factorypath
.project
.settings
.springBeans
.sts4-cache
bin/
!**/src/main/**/bin/
!**/src/test/**/bin/

### IntelliJ IDEA ###
.idea
*.iws
*.iml
*.ipr
out/
!**/src/main/**/out/
!**/src/test/**/out/

### NetBeans ###
/nbproject/private/
/nbbuild/
/dist/
/nbdist/
/.nb-gradle/

### VS Code ###
.vscode/

node_modules/

dist/