chore: github 이슈 템플릿 개선

kgu-dtcg-labs · Nov 19, 2024 · a36fe00 · a36fe00
1 parent 1bb1294
commit a36fe00
Show file tree

Hide file tree

Showing 5 changed files with 26 additions and 23 deletions.
diff --git a/.github/ISSUE_TEMPLATE/bug.yml b/.github/ISSUE_TEMPLATE/bug.yml
@@ -6,28 +6,28 @@ body:
   - type: textarea
     attributes:
       label: 버그 설명
-      description: 버그에 대한 설명을 작성해 주세요
+      description: 버그에 대한 설명을 작성해 주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: 예상 결과
-      description: 예상한 결과를 작성해 주세요
+      description: 예상한 결과를 작성해 주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: 실제 결과
-      description: 실제 결과를 작성해 주세요
+      description: 실제 결과를 작성해 주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: 시뮬레이션
-      description: 버그를 발견하게 된 상황을 단계별로 적어주세요
+      description: 버그를 발견하게 된 상황을 단계별로 적어주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: ETC
-      description: 더 전달할 내용이 있다면 여기에 작성해주세요
+      description: 더 전달할 내용이 있다면 여기에 작성해 주세요.
diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml
@@ -6,18 +6,18 @@ body:
   - type: textarea
     attributes:
       label: Describe
-      description: 새로운 기능에 대한 설명을 작성해 주세요
-      placeholder: 자세히 적을수록 좋아요.
+      description: 새로운 기능에 대한 설명을 작성해 주세요.
+      placeholder: 자세히 적을수록 좋습니다.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Tasks
-      description: 해야 하는 일에 대한 Tasks를 작성해 주세요
+      description: 해야 하는 일에 대한 Tasks를 작성해 주세요.
       placeholder: 최대한 세분화 해서 적어주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: ETC
-      description: 더 전달할 내용이 있다면 여기에 작성해 주세요
+      description: 더 전달할 내용이 있다면 여기에 작성해주 세요.
diff --git a/.github/ISSUE_TEMPLATE/refactor.yml b/.github/ISSUE_TEMPLATE/refactor.yml
@@ -6,18 +6,18 @@ body:
   - type: textarea
     attributes:
       label: Describe
-      description: 왜 리팩터링을 해야하는지 설명해 주세요
-      placeholder: 자세히 적을수록 좋아요.
+      description: 왜 리팩터링을 해야하는지 설명해 주세요.
+      placeholder: 자세히 적을수록 좋습니다.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Tasks
-      description: 리팩터링에 대한 Tasks를 작성해 주세요
+      description: 리팩터링을 할 부분에 대해서 자세히 작성해 주세요.
       placeholder: 최대한 세분화 해서 적어주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: ETC
-      description: 더 전달할 내용이 있다면 여기에 작성해 주세요
+      description: 더 전달할 내용이 있다면 여기에 작성해 주세요.
diff --git a/.github/ISSUE_TEMPLATE/suggestion.yml b/.github/ISSUE_TEMPLATE/suggestion.yml
@@ -6,18 +6,18 @@ body:
   - type: textarea
     attributes:
       label: Describe
-      description: 주제에 대한 설명을 작성해 주세요
-      placeholder: 자세히 적을수록 좋아요.
+      description: 회의 주제에 대한 설명을 작성해 주세요.
+      placeholder: 자세히 적을수록 좋습니다.
     validations:
       required: true
   - type: textarea
     attributes:
       label: Tasks
-      description: 주제에 대한 Tasks를 작성해 주세요
+      description: 해야 하는 일에 대한 Tasks를 작성해 주세요.
       placeholder: 최대한 세분화 해서 적어주세요.
     validations:
       required: true
   - type: textarea
     attributes:
       label: ETC
-      description: 더 전달할 내용이 있다면 여기에 작성해 주세요
+      description: 더 전달할 내용이 있다면 여기에 작성해 주세요.
diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md
@@ -1,18 +1,21 @@
 ## Summary
 
-> 관련 있는 Issue를 태그해주세요.
+> 관련 있는 Issue를 태그해주세요. (e.g. closed, fixed, resolved, related, #100)
 
-**해당 PR에 대한 요약을 작성해주세요.**
+_해당 PR에 대한 작업 요약을 작성해주세요._
 
 ## Tasks
 
-- 해당 PR에 포함된 작업을 작성해주세요.
-- 해당 PR에 포함된 작업을 작성해주세요.
+- _해당 PR에 수행한 작업을 작성해주세요._
 
+<!--
 ## To Reviewer
 
-_(없을 경우 삭제) 더 전달할 내용이 있다면 여기에 작성해주세요._
+(기재 내용 없을 경우 섹션 삭제) 더 전달할 내용이 있다면 여기에 작성해주세요.
+-->
 
+<!--
 ## Screenshot
 
-_(없을 경우 삭제) 작업한 내용에 대한 스크린샷을 첨부해주세요._
+(기재 내용 없을 경우 섹션 삭제) 작업한 내용에 대한 스크린샷을 첨부해주세요.
+-->