chore(github): use issue forms
This change converts go-ipfs to the new issue forms. Initial implementation by @RubenKelvera in https://github.com/ipfs/go-ipfs/pull/7967. The version here: 1. Converts all forms. 2. Asks fewer questions (for bug reports). We can expand the form later, but I always hated bugzilla bug report forms.
Steven Allen committed
Jul 19, 2021 at 19:08 UTC
a757234149398d855ca5846924a1df57f3626e9d
8 files changed
+145
-63
.github/ISSUE_TEMPLATE/bug-report.md
deleted
-23
@@ -1,23 +0,0 @@
1
----
2
-name: 'Bug Report'
3
-about: 'Report a bug in go-ipfs.'
4
-labels: kind/bug, need/triage
5
----
6
-
7
-<!-- Please report security issues by email to security@ipfs.io -->
8
-
9
-#### Version information:
10
-<!-- Output From `ipfs version --all`
11
-
12
-Please check dist.ipfs.io for a newer version of go-ipfs and update if necessary. Report back if the problem persists.
13
-
14
-If you can't run `ipfs version --all` or that command fails, include as much information as you can: IPFS version, computer architecture (e.g., Intel x86 64bit), operating system, etc. -->
15
-
16
-#### Description:
17
-<!-- This is where you get to tell us what went wrong. When doing so, please make sure to include *all* relevant information.
18
-
19
-Please try to include:
20
- * What you were doing when you experienced the bug.
21
- * Any error messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas).
22
- * When possible, steps to reliably produce the bug.
23
--->
.github/ISSUE_TEMPLATE/bug-report.yml
new
+55
@@ -0,0 +1,55 @@
1
+name: Bug Report
2
+description: Report a bug in go-ipfs.
3
+labels:
4
+ - kind/bug
5
+ - need/triage
6
+body:
7
+ - type: markdown
8
+ attributes:
9
+ value: |
10
+ - Make sure you are running the [latest version of go-ipfs][releases] before reporting an issue.
11
+ - If you have an enhancement or feature request for go-ipfs, please select [a different option][issues].
12
+ - Please report possible security issues by email to security@ipfs.io
13
+
14
+ [issues]: https://github.com/ipfs/go-ipfs/issues/new/choose
15
+ [releases]: https://github.com/ipfs/go-ipfs/releases
16
+ - type: checkboxes
17
+ attributes:
18
+ label: Checklist
19
+ description: Please verify that you've followed these steps
20
+ options:
21
+ - label: This is a bug report, not a question. Ask questions on [discuss.ipfs.io](https://discuss.ipfs.io).
22
+ required: true
23
+ - label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my bug.
24
+ required: true
25
+ - label: I am running the latest [go-ipfs version](https://dist.ipfs.io/#go-ipfs) or have an issue updating.
26
+ required: true
27
+ - type: dropdown
28
+ id: install
29
+ validations:
30
+ required: true
31
+ attributes:
32
+ label: Installation method
33
+ description: Please select your installation method
34
+ options:
35
+ - ipfs-desktop
36
+ - ipfs-update or dist.ipfs.io
37
+ - third-party binary
38
+ - built from source
39
+ - type: textarea
40
+ id: version
41
+ attributes:
42
+ label: Version
43
+ render: Text
44
+ description: |
45
+ Enter the output of `ipfs version --all`. If you can't run that command, please include a copy of your [gateway's version page](http://localhost:8080/api/v0/version?enc=text&all=true).
46
+ - type: textarea
47
+ attributes:
48
+ label: Description
49
+ description: |
50
+ This is where you get to tell us what went wrong. When doing so, please make sure to include *all* relevant information.
51
+
52
+ Please try to include:
53
+ * What you were doing when you experienced the bug.
54
+ * Any error messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas).
55
+ * When possible, steps to reliably produce the bug.
.github/ISSUE_TEMPLATE/doc.md
deleted
-14
@@ -1,14 +0,0 @@
1
----
2
-name: 'Documentation Issue'
3
-about: 'Report missing, erroneous docs, broken links or propose new go-ipfs docs'
4
-labels: topic/docs-ipfs, need/triage
5
----
6
-<!-- Problems with documentation on https://docs.ipfs.io should be reported to https://github.com/ipfs/ipfs-docs -->
7
-
8
-#### Location
9
-
10
-<!-- In the case of missing/erroneous documentation, where is the error? If possible, a link/URL would be great! -->
11
-
12
-#### Description
13
-
14
-<!-- Describe the documentation issue. -->
.github/ISSUE_TEMPLATE/doc.yml
new
+27
@@ -0,0 +1,27 @@
1
+name: Documentation Issue
2
+description: Report missing, erroneous docs, broken links or propose new go-ipfs docs.
3
+labels:
4
+ - topic/docs-ipfs
5
+ - need/triage
6
+body:
7
+ - type: markdown
8
+ attributes:
9
+ value: |
10
+ Problems with documentation on https://docs.ipfs.io should be reported to https://github.com/ipfs/ipfs-docs
11
+ - type: checkboxes
12
+ attributes:
13
+ label: Checklist
14
+ description: Please verify the following.
15
+ options:
16
+ - label: I am reporting a documentation issue in this repo, not https://docs.ipfs.io.
17
+ required: true
18
+ - type: input
19
+ attributes:
20
+ label: Location
21
+ description: |
22
+ If possible, please provide a link to the documentation issue.
23
+ - type: textarea
24
+ attributes:
25
+ label: Description
26
+ description: |
27
+ Please describe your issue.
.github/ISSUE_TEMPLATE/enhancement.md
deleted
-11
@@ -1,11 +0,0 @@
1
----
2
-name: 'Enhancement'
3
-about: 'Suggest an improvement to an existing go-ipfs feature.'
4
-labels: kind/enhancement
5
----
6
-
7
-<!--
8
-Note: If you'd like to suggest an idea related to IPFS but not specifically related to the Go implementation, please post in https://discuss.ipfs.io instead.
9
-
10
-When requesting an _enhancement_, please be sure to include your motivation and try to be as specific as possible.
11
--->
.github/ISSUE_TEMPLATE/enhancement.yml
new
+31
@@ -0,0 +1,31 @@
1
+name: Enhancement
2
+description: Suggest an improvement to an existing go-ipfs feature.
3
+labels:
4
+ - kind/enhancement
5
+body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Suggest an enhancement to go-ipfs (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io).
10
+
11
+ Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
12
+
13
+ If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
14
+
15
+ **Example:**
16
+
17
+ > Reduce memory usage of `ipfs cat` (specific) by buffering less in ... (actionable). This would let me run go-ipfs on my Raspberry Pi (motivated).
18
+ - type: checkboxes
19
+ attributes:
20
+ label: Checklist
21
+ description: Please verify the following.
22
+ options:
23
+ - label: My issue is specific & actionable.
24
+ required: true
25
+ - label: I am not suggesting a protocol enhancement.
26
+ required: true
27
+ - type: textarea
28
+ attributes:
29
+ label: Description
30
+ description: |
31
+ Please describe your idea. When requesting an enhancement, please be sure to include your motivation and try to be as specific as possible.
.github/ISSUE_TEMPLATE/feature.md
deleted
-15
@@ -1,15 +0,0 @@
1
----
2
-name: 'Feature'
3
-about: 'Suggest a new feature in go-ipfs.'
4
-labels: kind/feature, need/triage
5
----
6
-
7
-<!--
8
-Note: If you'd like to suggest an idea related to IPFS but not specifically related to the Go implementation, please post in https://discuss.ipfs.io instead.
9
-
10
-When requesting a _feature_, please be sure to include:
11
- * Your motivation. Why do you need the feature?
12
- * How the feature should work.
13
-
14
-Please try to be as specific and concrete as possible.
15
--->
.github/ISSUE_TEMPLATE/feature.yml
new
+32
@@ -0,0 +1,32 @@
1
+name: Feature
2
+description: Suggest a new feature in go-ipfs.
3
+labels:
4
+ - kind/feature
5
+body:
6
+ - type: markdown
7
+ attributes:
8
+ value: |
9
+ Suggest a new feature in go-ipfs (the program). If you'd like to suggest an improvement to the IPFS protocol, please discuss it on [the forum](https://discuss.ipfs.io).
10
+
11
+ Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
12
+
13
+ If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
14
+
15
+ **Example:**
16
+
17
+ > Reduce memory usage of `ipfs cat` (specific) by buffering less in ... (actionable). This would let me run go-ipfs on my Raspberry Pi (motivated).
18
+
19
+ - type: checkboxes
20
+ attributes:
21
+ label: Checklist
22
+ description: Please verify the following.
23
+ options:
24
+ - label: My issue is specific & actionable.
25
+ required: true
26
+ - label: I am not suggesting a protocol enhancement.
27
+ required: true
28
+ - type: textarea
29
+ attributes:
30
+ label: Description
31
+ description: |
32
+ Please describe your idea. When requesting a feature, please be sure to include your motivation and and a concrete description of how the feature should work.