From 1b1450e04f96bd8357b47584b29c2150791cddc1 Mon Sep 17 00:00:00 2001 From: Prem Chaitanya Prathi Date: Thu, 3 Aug 2023 18:28:41 +0530 Subject: [PATCH] Created issue templates (#622) * Created issue templates Added bug, feature, improvement and milestone issues templates. --- .github/ISSUE_TEMPLATE/bug_report.md | 36 +++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++++ .github/ISSUE_TEMPLATE/improvement.md | 18 +++++++++ .../milestone-issue-template.md | 40 +++++++++++++++++++ 4 files changed, 117 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/milestone-issue-template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 00000000..9b37ad6c --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,36 @@ +--- +name: Bug report +about: Create a report to help us improve +title: 'bug:' +labels: '' +assignees: '' + +--- + +**Describe the bug** +A clear and concise description of what the bug is. + +**To Reproduce** +Steps to reproduce the behavior: +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** +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information):** + - OS: [e.g. iOS] + - Browser [e.g. chrome, safari] + - Version [e.g. 22] + +### go-waku version/commit hash +State the version of `go-waku` where you've encountered the bug or, if built off a specific commit, the relevant commit hash. You can check the version by running `./build/waku --version`. +- e.g. `v0.7.0` or `e21bdab` + +**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 00000000..0de6187a --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,23 @@ +--- +name: Feature request +about: Suggest an idea for go-waku implementation +title: 'feat:' +labels: '' +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 00000000..29e4fc38 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/improvement.md @@ -0,0 +1,18 @@ +--- +name: Improvement +about: Suggest improvements to the codebase or processes. This includes refactoring, + docs and any other chores +title: 'chore:' +labels: '' +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/milestone-issue-template.md b/.github/ISSUE_TEMPLATE/milestone-issue-template.md new file mode 100644 index 00000000..6ce94e75 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/milestone-issue-template.md @@ -0,0 +1,40 @@ +--- +name: Milestone Issue Template +about: Track Milestones +title: "[Milestone] " +labels: milestone +assignees: '' + +--- + + + + +**Planned start date**: +**Due date**: + +# Summary + + + +# Acceptance Criteria + + + +## Tasks + + + +# RAID (Risks, Assumptions, Issues and Dependencies) + + + + + + + +