From 58e6e28dd5c4e672d2f1b55891b0171568ae059a Mon Sep 17 00:00:00 2001 From: Hanno Cornelius <68783915+jm-clius@users.noreply.github.com> Date: Wed, 31 Aug 2022 19:05:39 +0200 Subject: [PATCH] chore: update issue templates (#1105) --- .github/ISSUE_TEMPLATE/bug_report.md | 34 +++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++++ .github/ISSUE_TEMPLATE/improvement.md | 17 ++++++++++ .../ISSUE_TEMPLATE/research-related-issue.md | 19 +++++++++++ 4 files changed, 93 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/improvement.md create mode 100644 .github/ISSUE_TEMPLATE/research-related-issue.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 000000000..8e54bbf2d --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,34 @@ +--- +name: Bug report +about: Report any bugs or unexpected behavior +title: 'bug: ' +labels: bug, track:maintenance +assignees: '' + +--- + +### Problem +A clear and concise description of what the bug is. + +### Impact +Indicate how significant you believe the impact of the bug is. Bugs that lead to data loss or corruption would be considered `critical`. In such cases, please also add the `critical` label. + +### To reproduce +If you can reproduce the behavior, steps to reproduce: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Expected behavior +A clear and concise description of what you expected to happen. + +### Screenshots/logs +If applicable, add screenshots or logs to help explain your problem. + +### nwaku version/commit hash +State the version of `nwaku` where you've encountered the bug or, if built off a specific commit, the relevant commit hash. You can check the version by running `./wakunode2 --version`. +- e.g. `v0.9` or `ed53bcd` + +### 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 000000000..b0698f5c3 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for the nwaku implementation +title: 'feat: ' +labels: track:production +assignees: '' + +--- + +### Problem +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + +### Suggested solution +A clear and concise description of what you want to happen. + +### Alternatives considered +A clear and concise description of any alternative solutions or features you've considered. + +### Additional context +Add any other context or screenshots about the feature request here. + +### Acceptance criteria +A list of tasks that need to be done for the issue to be considered resolved. diff --git a/.github/ISSUE_TEMPLATE/improvement.md b/.github/ISSUE_TEMPLATE/improvement.md new file mode 100644 index 000000000..5dee34fb1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.md @@ -0,0 +1,17 @@ +--- +name: Improvement +about: Suggest improvements to the codebase or processes. This includes refactoring, + docs and any other chores. +title: 'chore:' +labels: track:maintenance +assignees: '' + +--- +### Background +A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]; There is a spelling error in [...]; It's difficult to read the code in module [...] + +### Details +A clear and concise description of what you want to happen. + +### Acceptance criteria +A list of tasks that need to be done for the issue to be considered resolved. diff --git a/.github/ISSUE_TEMPLATE/research-related-issue.md b/.github/ISSUE_TEMPLATE/research-related-issue.md new file mode 100644 index 000000000..b90b7d8d6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/research-related-issue.md @@ -0,0 +1,19 @@ +--- +name: Research-related issue +about: Use this template if your issue is related to any Vac research tracks +title: 'research:' +labels: '' +assignees: '' + +--- + +### Problem + +### Acceptance criteria + +### Details + +### Possible Solutions + +### Research track +Indicate the Vac research track that this issue relates to. Please also add the relevant track as a label.