Merge pull request #8279 from ipfs/feat/issue-forms

use issue forms
This commit is contained in:
Steven Allen 2021-07-20 12:40:35 -07:00 committed by GitHub
commit e2bb85792b
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
8 changed files with 158 additions and 63 deletions

View File

@ -1,23 +0,0 @@
---
name: 'Bug Report'
about: 'Report a bug in go-ipfs.'
labels: kind/bug, need/triage
---
<!-- Please report security issues by email to security@ipfs.io -->
#### Version information:
<!-- Output From `ipfs version --all`
Please check dist.ipfs.io for a newer version of go-ipfs and update if necessary. Report back if the problem persists.
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. -->
#### Description:
<!-- This is where you get to tell us what went wrong. When doing so, please make sure to include *all* relevant information.
Please try to include:
* What you were doing when you experienced the bug.
* Any error messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas).
* When possible, steps to reliably produce the bug.
-->

62
.github/ISSUE_TEMPLATE/bug-report.yml vendored Normal file
View File

@ -0,0 +1,62 @@
name: Bug Report
description: Report a bug in go-ipfs.
labels:
- kind/bug
- need/triage
body:
- type: markdown
attributes:
value: |
- Make sure you are running the [latest version of go-ipfs][releases] before reporting an issue.
- If you have an enhancement or feature request for go-ipfs, please select [a different option][issues].
- Please report possible security issues by email to security@ipfs.io
[issues]: https://github.com/ipfs/go-ipfs/issues/new/choose
[releases]: https://github.com/ipfs/go-ipfs/releases
- type: checkboxes
attributes:
label: Checklist
description: Please verify that you've followed these steps
options:
- label: This is a bug report, not a question. Ask questions on [discuss.ipfs.io](https://discuss.ipfs.io).
required: true
- label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my bug.
required: true
- label: I am running the latest [go-ipfs version](https://dist.ipfs.io/#go-ipfs) or have an issue updating.
required: true
- type: dropdown
id: install
validations:
required: true
attributes:
label: Installation method
description: Please select your installation method
options:
- ipfs-desktop
- ipfs-update or dist.ipfs.io
- third-party binary
- built from source
- type: textarea
id: version
attributes:
label: Version
render: Text
description: |
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).
- type: textarea
id: config
attributes:
label: Config
render: json
description: |
Enter the output of `ipfs config show`.
- type: textarea
attributes:
label: Description
description: |
This is where you get to tell us what went wrong. When doing so, please make sure to include *all* relevant information.
Please try to include:
* What you were doing when you experienced the bug.
* Any error messages you saw, *where* you saw them, and what you believe may have caused them (if you have any ideas).
* When possible, steps to reliably produce the bug.

View File

@ -1,14 +0,0 @@
---
name: 'Documentation Issue'
about: 'Report missing, erroneous docs, broken links or propose new go-ipfs docs'
labels: topic/docs-ipfs, need/triage
---
<!-- Problems with documentation on https://docs.ipfs.io should be reported to https://github.com/ipfs/ipfs-docs -->
#### Location
<!-- In the case of missing/erroneous documentation, where is the error? If possible, a link/URL would be great! -->
#### Description
<!-- Describe the documentation issue. -->

29
.github/ISSUE_TEMPLATE/doc.yml vendored Normal file
View File

@ -0,0 +1,29 @@
name: Documentation Issue
description: Report missing, erroneous docs, broken links or propose new go-ipfs docs.
labels:
- topic/docs-ipfs
- need/triage
body:
- type: markdown
attributes:
value: |
Problems with documentation on https://docs.ipfs.io should be reported to https://github.com/ipfs/ipfs-docs
- type: checkboxes
attributes:
label: Checklist
description: Please verify the following.
options:
- label: I am reporting a documentation issue in this repo, not https://docs.ipfs.io.
required: true
- label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue.
required: true
- type: input
attributes:
label: Location
description: |
If possible, please provide a link to the documentation issue.
- type: textarea
attributes:
label: Description
description: |
Please describe your issue.

View File

@ -1,11 +0,0 @@
---
name: 'Enhancement'
about: 'Suggest an improvement to an existing go-ipfs feature.'
labels: kind/enhancement
---
<!--
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.
When requesting an _enhancement_, please be sure to include your motivation and try to be as specific as possible.
-->

33
.github/ISSUE_TEMPLATE/enhancement.yml vendored Normal file
View File

@ -0,0 +1,33 @@
name: Enhancement
description: Suggest an improvement to an existing go-ipfs feature.
labels:
- kind/enhancement
body:
- type: markdown
attributes:
value: |
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).
Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
**Example:**
> Reduce memory usage of `ipfs cat` (specific) by buffering less in ... (actionable). This would let me run go-ipfs on my Raspberry Pi (motivated).
- type: checkboxes
attributes:
label: Checklist
description: Please verify the following.
options:
- label: My issue is specific & actionable.
required: true
- label: I am not suggesting a protocol enhancement.
required: true
- label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue.
required: true
- type: textarea
attributes:
label: Description
description: |
Please describe your idea. When requesting an enhancement, please be sure to include your motivation and try to be as specific as possible.

View File

@ -1,15 +0,0 @@
---
name: 'Feature'
about: 'Suggest a new feature in go-ipfs.'
labels: kind/feature, need/triage
---
<!--
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.
When requesting a _feature_, please be sure to include:
* Your motivation. Why do you need the feature?
* How the feature should work.
Please try to be as specific and concrete as possible.
-->

34
.github/ISSUE_TEMPLATE/feature.yml vendored Normal file
View File

@ -0,0 +1,34 @@
name: Feature
description: Suggest a new feature in go-ipfs.
labels:
- kind/feature
body:
- type: markdown
attributes:
value: |
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).
Issues in this repo must be specific, actionable, and well motivated. They should be starting points for _building_ new features, not brainstorming ideas.
If you have an idea you'd like to discuss, please open a new thread on [the forum](https://discuss.ipfs.io).
**Example:**
> Add deduplication-optimized chunking of tar files in `ipfs add` (specific) by examining tar headers ... (actionable). This would let me efficiently store and update many versions of code archives (motivated).
- type: checkboxes
attributes:
label: Checklist
description: Please verify the following.
options:
- label: My issue is specific & actionable.
required: true
- label: I am not suggesting a protocol enhancement.
required: true
- label: I have searched on the [issue tracker](https://github.com/ipfs/go-ipfs/issues?q=is%3Aissue) for my issue.
required: true
- type: textarea
attributes:
label: Description
description: |
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.