diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md deleted file mode 100644 index 72d014c8f..000000000 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -name: 'Bug Report' -about: 'Report a bug in go-ipfs.' -labels: kind/bug, need/triage ---- - - - -#### Version information: - - -#### Description: - diff --git a/.github/ISSUE_TEMPLATE/bug-report.yml b/.github/ISSUE_TEMPLATE/bug-report.yml new file mode 100644 index 000000000..96b29dc8b --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/doc.md b/.github/ISSUE_TEMPLATE/doc.md deleted file mode 100644 index 0a5432f57..000000000 --- a/.github/ISSUE_TEMPLATE/doc.md +++ /dev/null @@ -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 ---- - - -#### Location - - - -#### Description - - diff --git a/.github/ISSUE_TEMPLATE/doc.yml b/.github/ISSUE_TEMPLATE/doc.yml new file mode 100644 index 000000000..dc9034fae --- /dev/null +++ b/.github/ISSUE_TEMPLATE/doc.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/enhancement.md b/.github/ISSUE_TEMPLATE/enhancement.md deleted file mode 100644 index 8c1c31c0d..000000000 --- a/.github/ISSUE_TEMPLATE/enhancement.md +++ /dev/null @@ -1,11 +0,0 @@ ---- -name: 'Enhancement' -about: 'Suggest an improvement to an existing go-ipfs feature.' -labels: kind/enhancement ---- - - diff --git a/.github/ISSUE_TEMPLATE/enhancement.yml b/.github/ISSUE_TEMPLATE/enhancement.yml new file mode 100644 index 000000000..f1be06c35 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement.yml @@ -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. diff --git a/.github/ISSUE_TEMPLATE/feature.md b/.github/ISSUE_TEMPLATE/feature.md deleted file mode 100644 index 0cd141dc7..000000000 --- a/.github/ISSUE_TEMPLATE/feature.md +++ /dev/null @@ -1,15 +0,0 @@ ---- -name: 'Feature' -about: 'Suggest a new feature in go-ipfs.' -labels: kind/feature, need/triage ---- - - diff --git a/.github/ISSUE_TEMPLATE/feature.yml b/.github/ISSUE_TEMPLATE/feature.yml new file mode 100644 index 000000000..62414cabb --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature.yml @@ -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.