From db238f92e8d264cdfd016cddd3d84dc2ef8c2a21 Mon Sep 17 00:00:00 2001 From: Lyall Stewart Date: Thu, 26 Dec 2024 10:28:30 +0000 Subject: [PATCH 1/6] Create bug_report.md --- .github/ISSUE_TEMPLATE/bug_report.md | 30 ++++++++++++++++++++++++++++ 1 file changed, 30 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/bug_report.md diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md new file mode 100644 index 0000000..a44c1a1 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.md @@ -0,0 +1,30 @@ +--- +name: Bug report +about: Create a report to help us improve +title: '' +labels: bug +assignees: '' +--- + +## Describe the bug +A clear and concise description of what the bug is. + +## Expected behavior +A clear and concise description of what you expected to happen. + +## To Reproduce +Steps to reproduce the behavior: +1. Go to '...' +2. Click on '....' +3. Scroll down to '....' +4. See error + +### Screenshots +If applicable, add screenshots to help explain your problem. + +**Desktop (please complete the following information if applicable):** + - OS: [e.g. iOS, macOS, Win, Linux] + - Browser [e.g. chrome, safari] + +## Additional context +Add any other context about the problem here. From e57522cae159bb71ea3906985a862dc23954c622 Mon Sep 17 00:00:00 2001 From: Lyall Stewart Date: Thu, 26 Dec 2024 10:30:22 +0000 Subject: [PATCH 2/6] Create feature_request.md --- .github/ISSUE_TEMPLATE/feature_request.md | 27 +++++++++++++++++++++++ 1 file changed, 27 insertions(+) create mode 100644 .github/ISSUE_TEMPLATE/feature_request.md diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md new file mode 100644 index 0000000..4d3d6ec --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.md @@ -0,0 +1,27 @@ +--- +name: Feature request +about: Suggest an idea for this project +title: '' +labels: enhancement +assignees: '' +--- + +## Purpose +What will this feature provide? + +### 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 [...] + +## Proposed Solution +If you have an idea on how to implement this feature, please share! + +### Describe alternatives you've considered (optional) +A clear and concise description of any alternative solutions or features you've considered. + +## Acceptance Criteria +Please list the requirements the implementation of this feature should meet. +- This feature should do [x]. +- This feature should do [y]. + +## Additional context +Add any other context or screenshots about the feature request here. From 7ae5b5b76764392a0c503e545ec4af04a0f9aa4b Mon Sep 17 00:00:00 2001 From: Lyall Stewart Date: Thu, 26 Dec 2024 10:37:28 +0000 Subject: [PATCH 3/6] Create pull_request_template.md --- .github/pull_request_template.md | 28 ++++++++++++++++++++++++++++ 1 file changed, 28 insertions(+) create mode 100644 .github/pull_request_template.md diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md new file mode 100644 index 0000000..fce0d43 --- /dev/null +++ b/.github/pull_request_template.md @@ -0,0 +1,28 @@ +## What issue is this solving? + + +Closes #??? + +### Description + + + + +## Any helpful knowledge/context for the reviewer? + +- Any new dependencies to install? +- Any special requirements to test? +- Any UI changes? Include screenshots if so. + +### Feelings gif (optional) + +What gif best describes your feeling working on this issue? https://giphy.com/ +How to embed: +`![alt text](https://media.giphy.com/media/1nP7ThJFes5pgXKUNf/giphy.gif)` + +### Please make sure you've attempted to meet the following coding standards + +- [ ] Code has been tested and does not produce errors +- [ ] Code is readable and formatted +- [ ] There isn't any unnecessary commented-out code +- [ ] If you have made any UI changes, include a screenshot of them. From 080ce8105c73e448eaab565be2d951759896835b Mon Sep 17 00:00:00 2001 From: Lyall Stewart Date: Thu, 26 Dec 2024 10:59:51 +0000 Subject: [PATCH 4/6] Replace old syle MD with new style YAML forms syntax --- .github/ISSUE_TEMPLATE/bug_report.md | 30 ------------ .github/ISSUE_TEMPLATE/bug_report.yml | 56 ++++++++++++++++++++++ .github/ISSUE_TEMPLATE/feature_request.md | 27 ----------- .github/ISSUE_TEMPLATE/feature_request.yml | 38 +++++++++++++++ .github/pull_request_template.md | 2 + .gitignore | 2 +- 6 files changed, 97 insertions(+), 58 deletions(-) delete mode 100644 .github/ISSUE_TEMPLATE/bug_report.md create mode 100644 .github/ISSUE_TEMPLATE/bug_report.yml delete mode 100644 .github/ISSUE_TEMPLATE/feature_request.md create mode 100644 .github/ISSUE_TEMPLATE/feature_request.yml diff --git a/.github/ISSUE_TEMPLATE/bug_report.md b/.github/ISSUE_TEMPLATE/bug_report.md deleted file mode 100644 index a44c1a1..0000000 --- a/.github/ISSUE_TEMPLATE/bug_report.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -name: Bug report -about: Create a report to help us improve -title: '' -labels: bug -assignees: '' ---- - -## Describe the bug -A clear and concise description of what the bug is. - -## Expected behavior -A clear and concise description of what you expected to happen. - -## To Reproduce -Steps to reproduce the behavior: -1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error - -### Screenshots -If applicable, add screenshots to help explain your problem. - -**Desktop (please complete the following information if applicable):** - - OS: [e.g. iOS, macOS, Win, Linux] - - Browser [e.g. chrome, safari] - -## Additional context -Add any other context about the problem here. diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml new file mode 100644 index 0000000..c653909 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -0,0 +1,56 @@ +name: Report a Bug +description: File a bug/issue +title: "" +labels: ["Bug"] +body: + - type: textarea + attributes: + label: Current Behavior + description: A clear and concise description of what the bug is.. + validations: + required: true + - type: textarea + attributes: + label: Expected Behavior + description: A clear and concise description of what you expected to happen. + validations: + required: true + - type: textarea + attributes: + label: Steps To Reproduce + description: Steps to reproduce the behavior. + placeholder: | + 1. Go to '...' + 1. Click on '...' + 1. Scroll down to '...' + 1. See error + validations: + required: true + - type: textarea + attributes: + label: Screenshots + description: | + If appropriate, please share any screenshots of the bug. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. + validations: + required: false + - type: textarea + attributes: + label: Environment + description: | + Please share the following information, if applicable. For example: + - **OS**: Ubuntu 20.04 + - **Browser**: Firefox 133.0.3 + value: | + - OS: + - Browser: + render: markdown + validations: + required: false + - type: textarea + attributes: + label: Anything else? + description: | + Any additional context about the problem here. + validations: + required: false diff --git a/.github/ISSUE_TEMPLATE/feature_request.md b/.github/ISSUE_TEMPLATE/feature_request.md deleted file mode 100644 index 4d3d6ec..0000000 --- a/.github/ISSUE_TEMPLATE/feature_request.md +++ /dev/null @@ -1,27 +0,0 @@ ---- -name: Feature request -about: Suggest an idea for this project -title: '' -labels: enhancement -assignees: '' ---- - -## Purpose -What will this feature provide? - -### 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 [...] - -## Proposed Solution -If you have an idea on how to implement this feature, please share! - -### Describe alternatives you've considered (optional) -A clear and concise description of any alternative solutions or features you've considered. - -## Acceptance Criteria -Please list the requirements the implementation of this feature should meet. -- This feature should do [x]. -- This feature should do [y]. - -## Additional context -Add any other context or screenshots about the feature request here. diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml new file mode 100644 index 0000000..659b1a6 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -0,0 +1,38 @@ +name: Feature Request +description: Suggest a new idea for this project +title: "<title>" +labels: ["enhancement"] +body: + - type: textarea + attributes: + label: Purpose + description: What will this feature provide? + validations: + required: true + - type: textarea + attributes: + label: Is your feature request related to a problem? Please describe. + description: A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] + validations: + required: false + - type: textarea + attributes: + label: Proposed Solution + description: If you have an idea on how to implement this feature, please share! + validations: + required: false + - type: textarea + attributes: + label: Acceptance Criteria + description: Please list the requirements the implementation of this feature needs to meet. + placeholder: | + - This feature should do [xyz] + - This feature should do [abc] + validations: + required: true + - type: textarea + attributes: + label: Additional Context + description: | + Add any other context or screenshots here. + Tip: You can attach images or log files by clicking this area to highlight it and then dragging files in. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index fce0d43..1ece744 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,11 @@ ## What issue is this solving? <!-- replace ??? with the issue number. This will ensure the related issue is automatically closed when the PR is merged. --> + Closes #??? ### Description + <!-- Brief description of change --> <!-- Add any additional expected behavior here if it is not described in the linked issue. --> diff --git a/.gitignore b/.gitignore index a547bf3..cd6e74a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# Logs +git# Logs logs *.log npm-debug.log* From 923b35959c876a2e6e9e7ba84372f053cbdd97b4 Mon Sep 17 00:00:00 2001 From: Lyall Stewart <me@lyallstewart.com> Date: Thu, 26 Dec 2024 11:11:28 +0000 Subject: [PATCH 5/6] Add option for a blank issue just in case --- .github/ISSUE_TEMPLATE/config.yml | 1 + .github/pull_request_template.md | 1 - .gitignore | 2 +- 3 files changed, 2 insertions(+), 2 deletions(-) create mode 100644 .github/ISSUE_TEMPLATE/config.yml diff --git a/.github/ISSUE_TEMPLATE/config.yml b/.github/ISSUE_TEMPLATE/config.yml new file mode 100644 index 0000000..0086358 --- /dev/null +++ b/.github/ISSUE_TEMPLATE/config.yml @@ -0,0 +1 @@ +blank_issues_enabled: true diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 1ece744..0c7685f 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -27,4 +27,3 @@ How to embed: - [ ] Code has been tested and does not produce errors - [ ] Code is readable and formatted - [ ] There isn't any unnecessary commented-out code -- [ ] If you have made any UI changes, include a screenshot of them. diff --git a/.gitignore b/.gitignore index cd6e74a..a547bf3 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -git# Logs +# Logs logs *.log npm-debug.log* From 7ea4b61e554b243ee94e19f6c5ae26f1b6898ac7 Mon Sep 17 00:00:00 2001 From: Lyall Stewart <me@lyallstewart.com> Date: Thu, 26 Dec 2024 11:22:20 +0000 Subject: [PATCH 6/6] Remove undeeded title placeholders --- .github/ISSUE_TEMPLATE/bug_report.yml | 1 - .github/ISSUE_TEMPLATE/feature_request.yml | 1 - 2 files changed, 2 deletions(-) diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index c653909..1300593 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -1,6 +1,5 @@ name: Report a Bug description: File a bug/issue -title: "<title>" labels: ["Bug"] body: - type: textarea diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index 659b1a6..7c2a172 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -1,6 +1,5 @@ name: Feature Request description: Suggest a new idea for this project -title: "<title>" labels: ["enhancement"] body: - type: textarea