From f7b54630737b49a61c64687fbdb592a474ad8c35 Mon Sep 17 00:00:00 2001 From: CosminPerRam Date: Thu, 3 Aug 2023 21:36:03 +0300 Subject: [PATCH] [Crate] Add issue templates (#81) --- .github/ISSUE_TEMPLATE/bug_report.md | 23 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 14 +++++++++++ .../help-regarding-code-protocol-errors.md | 17 ++++++++++++++ 3 files changed, 54 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/help-regarding-code-protocol-errors.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..fbe8429 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,23 @@ +--- +name: Bug report +about: Create a report for a found bug +title: '' +labels: bug +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**Steps To Reproduce** +Please provide the steps to reproduce the behavior (if not possible, describe as many details as possible). + +**Expected behavior** +A clear and concise description of what you expected to happen. + +**Screenshots or Data** +If applicable, add screenshots/data to help explain your problem. + +**Additional context** +Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..a9ae259 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,14 @@ +--- +name: Feature request +about: Suggest a feature +title: '' +labels: enhancement +assignees: '' + +--- + +**What is this feature about?** +Shortly explain what your requested feature is about. + +**Additional context/references** +Add any other context or references about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/help-regarding-code-protocol-errors.md b/.github/ISSUE_TEMPLATE/help-regarding-code-protocol-errors.md new file mode 100644 index 0000000..88c286f --- /dev/null +++ b/.github/ISSUE_TEMPLATE/help-regarding-code-protocol-errors.md @@ -0,0 +1,17 @@ +--- +name: Help regarding code/protocol errors +about: Use this if you can't figure out how to use something. +title: '' +labels: '' +assignees: '' + +--- + +**This issue shall be made only if you have already gone through the docs, have you done it?** +Please state if there is something confusing regarding the docs (eg. location or wording). + +**What's you problem?** +State as concise as possible what you want to do and can't do. + +**Suggestions to make this clearer** +Mention how could stuff be improved so that someone doesn't have the same problem as you (eg. Error should give more information).