Skip to content

Commit

Permalink
Merge pull request #603 from beanbeanjuice/584-improve-templates
Browse files Browse the repository at this point in the history
Improved Templates
  • Loading branch information
beanbeanjuice committed Oct 30, 2023
2 parents 8cffd3f + 33fac7e commit 58ca139
Show file tree
Hide file tree
Showing 6 changed files with 39 additions and 25 deletions.
2 changes: 1 addition & 1 deletion .github/FUNDING.yml
Expand Up @@ -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']
custom: ['https://www.buymeacoffee.com/beanbeanjuice']
19 changes: 10 additions & 9 deletions .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**"
Expand All @@ -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.
- [ ] This is a bug report, not a feature request, improvement request, or security vulnerability report.
9 changes: 5 additions & 4 deletions .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**"
Expand All @@ -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.
- [ ] This is a feature request, not an improvement request, bug report, or security vulnerability report.
7 changes: 4 additions & 3 deletions .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**"
Expand All @@ -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.
- [ ] This is an improvement request, not a feature request, bug report, or security vulnerability report.
7 changes: 4 additions & 3 deletions .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**"
Expand All @@ -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.
- [ ] This is a security vulnerability report, not a feature request, improvement request, or a bug report.
20 changes: 15 additions & 5 deletions .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)
Expand All @@ -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).
Expand All @@ -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.
- [ ] Changes have been documented in the current draft [cafeBot Releases](https://github.com/beanbeanjuice/cafeBot/releases) update.

0 comments on commit 58ca139

Please sign in to comment.