From 4fc525dd4555a35ca93dce700dcd259bcabebd82 Mon Sep 17 00:00:00 2001 From: Chiara Rasi Date: Fri, 17 Jan 2025 07:44:25 +0100 Subject: [PATCH] Add custom issue and PR templates --- .github/ISSUE_TEMPLATE/bug_report.md | 29 +++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 20 ++++++++++++++++ .github/ISSUE_TEMPLATE/other_issue.md | 10 ++++++++ .github/PULL_REQUEST_TEMPLATE.md | 13 ++++++++++ CHANGELOG.md | 2 ++ 5 files changed, 74 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/other_issue.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 new file mode 100644 index 0000000..34761af --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,29 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: '' +assignees: '' + +--- + +Thank you for taking the time to contribute an issue! + +**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. + +**Additional context** +Add any other context about the problem here. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..1f37ec0 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,20 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: '' +assignees: '' + +--- + +**Is your feature request related to a problem in the current program to new available techology or software? Please describe and add links/citations if appropriate.** +A clear and concise description of what the problem is or what the advance you would like us to incorporate is. Ex. when triaging structural variantS, I would like to [...] + +**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. \ No newline at end of file diff --git a/.github/ISSUE_TEMPLATE/other_issue.md b/.github/ISSUE_TEMPLATE/other_issue.md new file mode 100644 index 0000000..9923d6e --- /dev/null +++ b/.github/ISSUE_TEMPLATE/other_issue.md @@ -0,0 +1,10 @@ +--- +name: Other issue +about: Describe your issue, request or question here +title: '' +labels: '' +assignees: '' + +--- + +Try to be as clear and precise as possible, adding sufficient detail and context. \ No newline at end of file diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..c139069 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,13 @@ +## Description + +### How to test + +### Expected test outcome + +## Review +- [ ] Tests executed by + +### This [version](https://semver.org/) is a +- [ ] **MAJOR** - when you make incompatible API changes +- [ ] **MINOR** - when you add functionality in a backwards compatible manner +- [ ] **PATCH** - when you make backwards compatible bug fixes or documentation/instructions \ No newline at end of file diff --git a/CHANGELOG.md b/CHANGELOG.md index a6d9874..f038e26 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,6 +1,8 @@ # Change Log # [unreleased] +### Changed +- Use custom issue and pull request templates in this repository ### Fixed - Do not include `[success]` lines in the streamed outfiles