From 16b2c383ac030ba04639c585d9d212fbd84aea8b Mon Sep 17 00:00:00 2001 From: beanbeanjuice Date: Mon, 30 Oct 2023 09:56:00 -0700 Subject: [PATCH 1/2] Improved Templates --- .github/FUNDING.yml | 2 +- .github/ISSUE_TEMPLATE/bug-report.md | 19 +++++++++--------- .github/ISSUE_TEMPLATE/feature-request.md | 9 +++++---- .github/ISSUE_TEMPLATE/improvement-request.md | 7 ++++--- .../ISSUE_TEMPLATE/security-vulnerability.md | 7 ++++--- .github/pull_request_template.md | 20 ++++++++++++++----- 6 files changed, 39 insertions(+), 25 deletions(-) diff --git a/.github/FUNDING.yml b/.github/FUNDING.yml index 154de1de..24f1e03c 100644 --- a/.github/FUNDING.yml +++ b/.github/FUNDING.yml @@ -9,4 +9,4 @@ # liberapay: # Replace with a single Liberapay username # issuehunt: # Replace with a single IssueHunt username # otechie: # Replace with a single Otechie username -custom: ['https://www.buymeacoffee.com/beanbeanjuice'] \ No newline at end of file +custom: ['https://www.buymeacoffee.com/beanbeanjuice'] diff --git a/.github/ISSUE_TEMPLATE/bug-report.md b/.github/ISSUE_TEMPLATE/bug-report.md index 1e76698d..ada5e3d2 100644 --- a/.github/ISSUE_TEMPLATE/bug-report.md +++ b/.github/ISSUE_TEMPLATE/bug-report.md @@ -1,4 +1,5 @@ --- + name: Bug Report about: Create a bug report telling us exactly what is wrong. title: "[BUG] **DESCRIBE YOUR ISSUE AS SHORT AS POSSIBLE IN THIS BOX**" @@ -10,33 +11,33 @@ assignees: beanbeanjuice ## Bug Description A clear and concise description of what the bug is. -___ +--- ## Steps to Reproduce the Bug 1. Go to '...' -2. Click on '....' -3. Scroll down to '....' -4. See error +1. Click on '....' +1. Scroll down to '....' +1. See error -___ +--- ## Expected Behaviour A clear and concise description of what you expected to happen. -___ +--- ## Screenshots/Videos If applicable, add screenshots or videos to help explain your problem. Links are preferred. -___ +--- ## Additional Context Add any other context about the problem here. -___ +--- ## Checklist - [ ] I have checked for similar issues. -- [ ] This is a bug report, not a feature request, improvement request, or security vulnerability report. \ No newline at end of file +- [ ] This is a bug report, not a feature request, improvement request, or security vulnerability report. diff --git a/.github/ISSUE_TEMPLATE/feature-request.md b/.github/ISSUE_TEMPLATE/feature-request.md index 9464a2c1..723beee1 100644 --- a/.github/ISSUE_TEMPLATE/feature-request.md +++ b/.github/ISSUE_TEMPLATE/feature-request.md @@ -1,4 +1,5 @@ --- + name: Feature Request about: Suggest an idea for this project. title: "[FEATURE] **DESCRIBE THE FEATURE YOU WANT AS SHORT AS POSSIBLE HERE**" @@ -10,19 +11,19 @@ assignees: beanbeanjuice ## Feature Description A clear and concise description of what you want to happen. -___ +--- ## Feature Alternatives 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. -___ +--- ## Checklist - [ ] I have checked for similar issues. -- [ ] This is a feature request, not an improvement request, bug report, or security vulnerability report. \ No newline at end of file +- [ ] This is a feature request, not an improvement request, bug report, or security vulnerability report. diff --git a/.github/ISSUE_TEMPLATE/improvement-request.md b/.github/ISSUE_TEMPLATE/improvement-request.md index 0b72a450..e655ea81 100644 --- a/.github/ISSUE_TEMPLATE/improvement-request.md +++ b/.github/ISSUE_TEMPLATE/improvement-request.md @@ -1,4 +1,5 @@ --- + name: Improvement Request about: Suggest an improvement for this project. title: "[IMPROVEMENT] **DESCRIBE THE IMPROVEMENT YOU WANT AS SHORT AS POSSIBLE HERE**" @@ -10,14 +11,14 @@ assignees: beanbeanjuice ## Improvement Description A clear and concise description of what you want to happen. Diagrams and drawings are welcome. -___ +--- ## Additional Context Add any other context or screenshots about the improvement request here. -___ +--- ## Checklist - [ ] I have checked for similar issues. -- [ ] This is an improvement request, not a feature request, bug report, or security vulnerability report. \ No newline at end of file +- [ ] This is an improvement request, not a feature request, bug report, or security vulnerability report. diff --git a/.github/ISSUE_TEMPLATE/security-vulnerability.md b/.github/ISSUE_TEMPLATE/security-vulnerability.md index a616e055..0afb2b7a 100644 --- a/.github/ISSUE_TEMPLATE/security-vulnerability.md +++ b/.github/ISSUE_TEMPLATE/security-vulnerability.md @@ -1,4 +1,5 @@ --- + name: Security Vulnerability Report about: Report a security vulnerability on this project. title: "[SECURITY ISSUE] **DESCRIBE THE SECURITY VULNERABILITY AS SHORT AS POSSIBLE HERE**" @@ -10,14 +11,14 @@ assignees: beanbeanjuice ## Security Vulnerability Description A clear and concise description of what you want to happen. -___ +--- ## Additional Context Add any other context or screenshots about the security vulnerability here. -___ +--- ## Checklist - [ ] I have checked for similar issues. -- [ ] This is a security vulnerability report, not a feature request, improvement request, or a bug report. \ No newline at end of file +- [ ] This is a security vulnerability report, not a feature request, improvement request, or a bug report. diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 04f1231a..429ab117 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -1,9 +1,15 @@ -# Description +# Pull Request + +--- + +## Description *Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.* Fixes # (issue) +--- + ## Type of Change - [ ] Bug Fix (Small Non-Code Breaking Issue) @@ -19,14 +25,18 @@ Fixes # (issue) - [ ] Documentation - [ ] Other: _____ -**Test Configuration**: +--- + +## Test Configuration * Hardware: - CPU: - GPU: - RAM: -* JDK: Java Oracle OpenJDK 16 +* JDK: Java OpenJDK 21 + +--- -# Checklist: +## Checklist: - [ ] This pull request has been linked to the appropriate issue on GitHub. (Use the development section on the right.) - [ ] The code follows the style [guidelines](https://github.com/beanbeanjuice/cafeBot/blob/master/CONTRIBUTING.md). @@ -39,4 +49,4 @@ Fixes # (issue) - [ ] New and existing Maven CI tests have passed. - [ ] The pull request is properly merging into the correct branch. - [ ] All existing local code has been pushed to the GitHub repository. -- [ ] Changes have been documented in the current draft [cafeBot Releases](https://github.com/beanbeanjuice/cafeBot/releases) update. \ No newline at end of file +- [ ] Changes have been documented in the current draft [cafeBot Releases](https://github.com/beanbeanjuice/cafeBot/releases) update. From 33fac7e4edb37fbe7318cfcf13b05225268980f3 Mon Sep 17 00:00:00 2001 From: beanbeanjuice Date: Mon, 30 Oct 2023 09:57:47 -0700 Subject: [PATCH 2/2] Removed Colon from Checklist --- .github/pull_request_template.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/.github/pull_request_template.md b/.github/pull_request_template.md index 429ab117..5e0bcc76 100644 --- a/.github/pull_request_template.md +++ b/.github/pull_request_template.md @@ -36,7 +36,7 @@ Fixes # (issue) --- -## Checklist: +## Checklist - [ ] This pull request has been linked to the appropriate issue on GitHub. (Use the development section on the right.) - [ ] The code follows the style [guidelines](https://github.com/beanbeanjuice/cafeBot/blob/master/CONTRIBUTING.md).