Skip to content

Commit 5b0c9ac

Browse files
authored
Merge pull request #7 from function-and-mountain/docs/add-issue_template
�docs: Add issue template
2 parents d9bcbb7 + c44d045 commit 5b0c9ac

File tree

3 files changed

+73
-0
lines changed

3 files changed

+73
-0
lines changed

.github/ISSUE_TEMPLATE/bug.yml

+49
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,49 @@
1+
name: 🐞 Bug Report
2+
description: 어떤 버그를 발견하셨나요?! 저희에게 제보해주세요!
3+
labels: [bug]
4+
title: '[🐞] 버그에 대한 간략한 제목을 작성해주세요'
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
버그 제보에 기여해주셔서 감사합니다! 다음 항목들을 채워가다 보면 issue가 완성되어 있을거에요.
10+
11+
- type: dropdown
12+
id: component
13+
attributes:
14+
label: 어느 부분에 문제가 발생했나요?
15+
options:
16+
- Docs
17+
- example
18+
- practice
19+
- 그 외
20+
21+
validations:
22+
required: true
23+
24+
- type: textarea
25+
id: description
26+
attributes:
27+
description: 문제에 대한 상세한 설명을 작성해주세요!
28+
label: 문제에 대해 설명해주세요!
29+
placeholder: 제가 뭘 했는데요... 제가 예상한 건 이건데... 실제로는 이렇게 동작하더라구요...
30+
31+
validations:
32+
required: true
33+
34+
- type: textarea
35+
id: reproduction-steps
36+
attributes:
37+
label: 재현하는 방법에 대해 알려주세요!
38+
description: 재현할 수 있는 방법에 대해 자세히 알려주세요. 만약 특정 환경에서만 발생하는 것 같다면, OS 및 환경에 대한 정보도 알려주세요
39+
placeholder: yarn test를 실행하는 와중에 발생했습니다.
40+
41+
- type: textarea
42+
id: additional_information
43+
attributes:
44+
label: 추가 정보
45+
description: 문제에 대해 못다한 이야기가 있나요? 여기서 자유롭게 작성해주세요!
46+
placeholder: 제 생각엔 이게 문제인 것 같습니다...
47+
48+
validations:
49+
required: false

.github/ISSUE_TEMPLATE/config.yml

+5
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,5 @@
1+
blank_issues_enabled: false
2+
contact_links:
3+
- name: 🤔 Support Question
4+
url: https://open.kakao.com/o/sTjHAUsf
5+
about: 궁금하신 사항을 오픈 카톡을 통해 쉽게 문의해볼 수 있어요!
+19
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
name: 📖 Documentation Suggestion
2+
description: Docs에 개선하고 싶은 문제나, 궁금하신 사항이 있나요?
3+
title: '[📖] 제안하고 싶은 내용이나 문제에 대해 간략한 제목을 작성해주세요'
4+
labels: ['docs']
5+
body:
6+
- type: markdown
7+
attributes:
8+
value: |
9+
Docs 개선에 관심을 갖고 방문해주셔서 감사합니다!
10+
저희 docs에는 모든 페이지에 `Edit this page`라는 버튼이 있습니다. 직접 수정하실 수 있는 내용 같아보인다면, PR을 대신 활용해주세요!
11+
![Screenshot](https://github.com/minsoo-web/ETC/assets/57122180/e713855b-e86b-4006-9b2c-532422deacb8)
12+
13+
- type: textarea
14+
id: description
15+
attributes:
16+
description: 제안하고 싶은 내용을 자세하고 명확하게 작성해주세요!
17+
label: 제안사항
18+
validations:
19+
required: true

0 commit comments

Comments
 (0)