From 1b0da27a89e2bea6a7b478416932efab07643ad8 Mon Sep 17 00:00:00 2001 From: Brent Huisman <brenthuisman@users.noreply.github.com> Date: Mon, 1 Mar 2021 16:16:27 +0100 Subject: [PATCH] Add AEP and PR template with ref to contrib guidelines and license (#1319) --- .github/ISSUE_TEMPLATE/bug_report.md | 20 +++---------------- .../ISSUE_TEMPLATE/enhancement_proposal.md | 8 ++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 17 ++-------------- .github/pull_request_template.md | 1 + 4 files changed, 14 insertions(+), 32 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/enhancement_proposal.md create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index e7c7f3ce..ddadd358 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -3,27 +3,13 @@ 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. title: '' -labels: '' +labels: 'bug' assignees: '' --- **Describe the bug** -A clear and concise description of what the bug is. - -**To Reproduce** -Steps to reproduce the behavior: -1. '...' - -**Expected behavior** -A clear and concise description of what you expected to happen. - -**Screenshots** -If applicable, add screenshots to help explain your problem. - -**System (please complete the following information):** - - OS: [e.g. Ubuntu] - - Version of relevant packages [e.g. Arbor 0.3, Conda Python 3.7] +A clear and concise description of what the bug is, steps to reproduce, expected behavior, etc. **Additional context** -Add any other context about the problem here. +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 new file mode 100644 index 00000000..173a6c21 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/enhancement_proposal.md @@ -0,0 +1,8 @@ +--- +name: Arbor Enhancement Proposal +about: 'An outline and rationale for a new feature or major change to Arbor. ' +title: 'AEP: [PROPOSAL]' +labels: 'AEP', 'enhancement' +assignees: '' + +--- diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 8b34bf1c..1d93c4c3 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -1,21 +1,8 @@ --- name: Feature request -about: 'Suggest an idea for this project. If you need help setting up your simulation - with Arbor, please start a new topic in Discussions. ' +about: 'Suggest an idea for Arbor. Add a clear and concise description of what the problem is and what you want to happen instead. ' title: '' -labels: '' +labels: 'enhancement', 'help wanted' assignees: '' --- - -**Is your feature request related to a problem? Please describe.** -A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] - -**Describe the solution you'd like** -A clear and concise description of what you want to happen. - -**Describe alternatives you've 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. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 00000000..224fb0d9 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1 @@ +Please make sure your PR follows our [contribution guidelines](https://github.com/arbor-sim/arbor/tree/master/doc/contrib) and agree to the terms outlined in the [PR procedure](https://github.com/arbor-sim/arbor/tree/master/doc/contrib/pr.rst). -- GitLab