From 23ecd89ebdcd804b27156e38a7089bbb2aa3c3d9 Mon Sep 17 00:00:00 2001 From: gagelarsen Date: Mon, 1 Jul 2024 09:54:02 -0600 Subject: [PATCH 1/2] update templates --- .github/ISSUE_TEMPLATE/bug_report.md | 37 +++++++++++++---------- .github/ISSUE_TEMPLATE/feature_request.md | 23 +++++++++----- 2 files changed, 36 insertions(+), 24 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md index fbb7453..890ce87 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -7,24 +7,29 @@ assignees: '' --- -**Describe the bug** -A clear and concise description of what the bug is. +## Summary -**To Reproduce** -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +(Summarize the bug encountered concisely) -**Expected behavior** -A clear and concise description of what you expected to happen. +## Steps to reproduce -**Screenshots** -If applicable, add screenshots to help explain your problem. +(How one can reproduce the issue - this is very important) -**Desktop (please complete the following information):** - - OS: [e.g. ubuntu-18.04] +## What is the current bug behavior? -**Additional context** -Add any other context about the problem here. +(What actually happens) + +## What is the expected correct behavior? + +(What you should see instead) + +## Relevant logs and/or screenshots + +(Paste any relevant logs - use code blocks (```) to format console output, logs, and code, as +it's very hard to read otherwise.) + +## Possible fixes + +(If you can, link to the line of code that might be responsible for the problem) + +/label ~bug ~reproduced ~needs-investigation diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index bbcbbe7..0b9c480 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -7,14 +7,21 @@ 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 [...] +### Description +This merge request addresses... -**Describe the solution you'd like** -A clear and concise description of what you want to happen. +### Changes Made to Code: + - Change 1 + - Change 2 -**Describe alternatives you've considered** -A clear and concise description of any alternative solutions or features you've considered. +### Related +Provide link to task or issue.. -**Additional context** -Add any other context or screenshots about the feature request here. +### Additional Notes +Any extra needed information.. + +### Quality Checks + - [ ] New code is 100% tested + - [ ] Code has been formated + - [ ] Code has been linted + - [ ] Docstrings for new methods have been added From be96a5e64419d192f04d721728b87f04fdcd4ada Mon Sep 17 00:00:00 2001 From: gagelarsen Date: Mon, 1 Jul 2024 10:04:43 -0600 Subject: [PATCH 2/2] update templates --- .github/ISSUE_TEMPLATE/feature_request.md | 22 +++++++----------- .github/pull_request_template.md | 27 +++++++++++++++++++++++ 2 files changed, 35 insertions(+), 14 deletions(-) create mode 100644 .github/pull_request_template.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md index 0b9c480..50ea8fb 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -8,20 +8,14 @@ assignees: '' --- ### Description -This merge request addresses... +Describe feature request... -### Changes Made to Code: - - Change 1 - - Change 2 - -### Related -Provide link to task or issue.. +### Why? +Why is the feature important? -### Additional Notes -Any extra needed information.. +### Estimated Effort +How long will this take? -### Quality Checks - - [ ] New code is 100% tested - - [ ] Code has been formated - - [ ] Code has been linted - - [ ] Docstrings for new methods have been added +### Changes to be Made: + - Change 1 + - Change 2 diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..41dc9e8 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,27 @@ +--- +name: Merge request +about: Create a request to help us grow +title: '' +labels: '' +assignees: '' + +--- + +### Description +This merge request addresses... + +### Changes Made to Code: + - Change 1 + - Change 2 + +### Related +Provide link to task or issue.. + +### Additional Notes +Any extra needed information.. + +### Quality Checks + - [ ] New code is 100% tested + - [ ] Code has been formated + - [ ] Code has been linted + - [ ] Docstrings for new methods have been added \ No newline at end of file