Skip to content

Commit 9e3ece6

Browse files
authored
Update issue templates
1 parent 6fb2d32 commit 9e3ece6

File tree

2 files changed

+83
-0
lines changed

2 files changed

+83
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+38
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
1. Go to '...'
16+
2. Click on '....'
17+
3. Scroll down to '....'
18+
4. See error
19+
20+
**Expected behavior**
21+
A clear and concise description of what you expected to happen.
22+
23+
**Screenshots**
24+
If applicable, add screenshots to help explain your problem.
25+
26+
**Desktop (please complete the following information):**
27+
- OS: [e.g. iOS]
28+
- Browser [e.g. chrome, safari]
29+
- Version [e.g. 22]
30+
31+
**Smartphone (please complete the following information):**
32+
- Device: [e.g. iPhone6]
33+
- OS: [e.g. iOS8.1]
34+
- Browser [e.g. stock browser, safari]
35+
- Version [e.g. 22]
36+
37+
**Additional context**
38+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/proposal.md

+45
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
---
2+
name: Proposal
3+
about: 新しいプラグインの仕組みのProposal
4+
title: ''
5+
labels: 'Status: Proposal'
6+
assignees: ''
7+
8+
---
9+
10+
# XXXのアーキテクチャ
11+
12+
## どう書ける?
13+
14+
- 実際のコード例
15+
16+
## どういう仕組み?
17+
18+
- prototypeを拡張しているなど具体的な仕組み
19+
- その機構のコードへのリンク
20+
- その仕組みやプラグインについてドキュメントへのリンク
21+
22+
## どういうことに向いている?
23+
24+
- どういう用途で使われてる(ユースケース)
25+
- 変換する毎にファイルとして吐き出さないので、高速に複数の変換をするのに向いている等
26+
27+
## どういうことに向いていない?
28+
29+
- 変換の仕組み上書き換え等を行うプラグインを扱いにくい等
30+
31+
## この仕組みを使っているもの
32+
33+
- XXX以外にも同様の仕組みを使っているものがあるなら
34+
35+
----
36+
37+
## チェックリスト
38+
39+
- [ ] どう書ける?
40+
- [ ] どういう仕組み?
41+
- [ ] どういうことに向いている?
42+
- [ ] どういうことに向いていない?
43+
- [ ] この仕組みを使っているもの
44+
- [ ] 実装してみよう
45+
- [ ] エコシステム

0 commit comments

Comments
 (0)