From f3dda0822efdf95c20c10b05b6fcbd6734d2e01e Mon Sep 17 00:00:00 2001 From: Brent Huisman <brenthuisman@users.noreply.github.com> Date: Wed, 6 Oct 2021 14:03:46 +0200 Subject: [PATCH] Improved Github Issue templates (#1698) --- .github/ISSUE_TEMPLATE/bug_report.md | 6 +++--- .github/ISSUE_TEMPLATE/enhancement_proposal.md | 16 ++++++++++++++-- .github/ISSUE_TEMPLATE/feature_request.md | 18 +++++++++++++++--- 3 files changed, 32 insertions(+), 8 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index 14498825..a587cced 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -1,16 +1,16 @@ --- name: Bug report -about: Create a report to help us improve. If you need help setting up your simulation - with Arbor, please start a new topic in Discussions. +about: If Arbor crashes, produces incorrect output or does something unexpected, please create a report to help us improve. title: '' labels: - 'bug' assignees: '' --- +<!-- Please add relevant labels to categorize your bug. --> **Describe the bug** <!-- A clear and concise description of what the bug is, steps to reproduce, expected behavior, etc. --> -**Additional context** +**Context** <!-- Add any other context about the problem here (e.g. OS, Arbor version, etc.). --> diff --git a/.github/ISSUE_TEMPLATE/enhancement_proposal.md b/.github/ISSUE_TEMPLATE/enhancement_proposal.md index 28885d1f..375a084c 100644 --- a/.github/ISSUE_TEMPLATE/enhancement_proposal.md +++ b/.github/ISSUE_TEMPLATE/enhancement_proposal.md @@ -1,10 +1,22 @@ --- name: Arbor Enhancement Proposal -about: 'An outline and rationale for a new feature or major change to Arbor. ' -title: 'AEP: [PROPOSAL]' +about: An outline and rationale for a new feature or major change to Arbor. Use this label ONLY if you have formulated this and have some or a few ideas for its implementation. +title: '' labels: - 'AEP' - 'enhancement' assignees: '' --- +<!-- Please add relevant labels to categorize your AEP. --> + +## Goal + + +## Rationale + + +## Scope + + +## Implementation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 2133fbef..8a6c2181 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,10 +1,22 @@ --- -name: Feature request -about: 'Suggest an idea for Arbor. Add a clear and concise description of what the problem is and what you want to happen instead. ' +name: Feature Request +about: Request a new feature that you need Arbor to have. Add a clear and concise description of what the feature addresses or solves and what you want to happen. The Arbor team will follow-up and help you flesh the feature out and help work towards an implementation. title: '' labels: -- 'enhancement' +- 'Feature Request' - 'help wanted' +- 'enhancement' +- 'neuroscience' assignees: '' --- +<!-- Please add/remove relevant labels to categorize your feature. --> + +**Describe the feature you need** +<!-- Example: I want Arbor to support file format X --> + +**Explain what it is supposed to enable** +<!-- Example: Model database Y can export in format X, which means I could use their models in Arbor. --> + +**Additional context** +<!-- Example: I'm writing a paper on the olfactory bulb and database Y has a model ready to go! --> -- GitLab