From b4df28ddddce2da5ed6bcbbd528d5181f01a33f2 Mon Sep 17 00:00:00 2001 From: Richard Moore Date: Tue, 27 Apr 2021 18:32:06 -0400 Subject: [PATCH] Update issue templates --- .github/ISSUE_TEMPLATE/bug-report.md | 24 +++++++++++++++++++ .../documentation-request-or-suggest.md | 10 ++++++++ .github/ISSUE_TEMPLATE/documentation.md | 16 +++++++++++++ .github/ISSUE_TEMPLATE/other-issue.md | 14 +++++++++++ .github/ISSUE_TEMPLATE/other.md | 16 +++++++++++++ 5 files changed, 80 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug-report.md create mode 100644 .github/ISSUE_TEMPLATE/documentation-request-or-suggest.md create mode 100644 .github/ISSUE_TEMPLATE/documentation.md create mode 100644 .github/ISSUE_TEMPLATE/other-issue.md create mode 100644 .github/ISSUE_TEMPLATE/other.md diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md new file mode 100644 index 000000000..779a787a8 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -0,0 +1,24 @@ +--- +name: Bug Report +about: Create a report to help us improve +title: '' +labels: investigate +assignees: '' + +--- + +Note: Not all sections may be relevant, but please be as thorough while remaining concise as possible. Remove this Notice and any sections that don't feel pertinent. + +If you are unsure if something is a bug, start a thread in the *"discussions"* tab above.. + +**Describe the bug** +A clear and concise description of what the bug is. + +**Reproduction steps** +Please include code snippets, with console.log output, any contract ABI, contract address, network and the full error. + +**Environment:** +Please include anything that may be useful in diagnosing the issue. Node vs Browser? Geth vs Parity vs Ganache? Third Party tools, like Hardhat? Mobile vs. Desktop? + +**Search Terms** +Often similar issues have come up before. Include any search terms you have tried in this repository's Issues (including closed issues) and *"Discussions"*, so if there are matching issues, we can be sure to add those keywords and link this issue to it, making it easier for people to find in the future. diff --git a/.github/ISSUE_TEMPLATE/documentation-request-or-suggest.md b/.github/ISSUE_TEMPLATE/documentation-request-or-suggest.md new file mode 100644 index 000000000..dbf69e875 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation-request-or-suggest.md @@ -0,0 +1,10 @@ +--- +name: Documentation Request or Suggest +about: Describe this issue template's purpose here. +title: '' +labels: '' +assignees: '' + +--- + + diff --git a/.github/ISSUE_TEMPLATE/documentation.md b/.github/ISSUE_TEMPLATE/documentation.md new file mode 100644 index 000000000..d1667bb3a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/documentation.md @@ -0,0 +1,16 @@ +--- +name: Documentation +about: Documentation Request or Suggest +title: '' +labels: documentation +assignees: '' + +--- + +Please include anything about the documentation you would like to see improved. + +- Missing information or details? +- Wrong Information? +- Dead or wrong links? +- Something needs code examples? +- General feedback or anything else? diff --git a/.github/ISSUE_TEMPLATE/other-issue.md b/.github/ISSUE_TEMPLATE/other-issue.md new file mode 100644 index 000000000..8756531aa --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other-issue.md @@ -0,0 +1,14 @@ +--- +name: Other Issue +about: Something Else +title: '' +labels: '' +assignees: '' + +--- + +Generally this issue template should be used. + +If your issue is not a **Feature Request**, **Bug Report** or problem with the **Documentation** you should use the *"Discussion"* tab at the top. + +But for truly exceptional issues, please include the details here. diff --git a/.github/ISSUE_TEMPLATE/other.md b/.github/ISSUE_TEMPLATE/other.md new file mode 100644 index 000000000..c8a723bab --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other.md @@ -0,0 +1,16 @@ +--- +name: Other +about: Something Else +title: '' +labels: '' +assignees: '' + +--- + +Generally this issue template should be used. + +If your issue is **not** a **Feature Request**, a **Bug Report** or problem with the **Documentation** you should probably be using the *"Discussion"* tab at the top. + +But for truly exceptional issues, please include the details here. + +Please also include any search terms you used when searching issues and discussions, so we can better tag those in the future.