-
Notifications
You must be signed in to change notification settings - Fork 8
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
chore(root): add and update github issue and pr templates
- Loading branch information
1 parent
52a5ea1
commit c18d41b
Showing
20 changed files
with
1,093 additions
and
63 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
.github/ISSUE_TEMPLATE/bug_report.md → .github/ISSUE_TEMPLATE/bug-report.md
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Build | ||
about: Suggest a change that would impact the build of the application | ||
title: "build(scope-of-issue): description" | ||
labels: 'dependencies' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Chore | ||
about: Suggest a task that can be implemented | ||
title: "chore(scope-of-issue): description" | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Continuous Integration | ||
about: Suggest a change to the current CI | ||
title: "ci(scope-of-issue): description" | ||
labels: '' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Docs | ||
about: Suggest a new addition to our documentation | ||
title: "docs(scope-of-issue): description" | ||
labels: 'documentation' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Feature | ||
about: Suggest an idea for this project | ||
title: "feat(scope-of-issue): description" | ||
labels: 'enhancement' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Performance | ||
about: Suggest a change that would impact the performance of an application | ||
title: "perf(scope-of-issue): description" | ||
labels: 'infra' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file was deleted.
Oops, something went wrong.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,24 @@ | ||
--- | ||
name: Testing | ||
about: Suggest a testing addition or change | ||
title: "test(scope-of-issue): description" | ||
labels: 'testing' | ||
assignees: '' | ||
|
||
--- | ||
|
||
## 🆘 **What is the problem at hand?** | ||
|
||
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...] | ||
|
||
## 🚀 **What is the impact of the problem? How is this problem important? How does it affect users/developpers?** | ||
|
||
A clear and concise description of how the problem impacts our current project. | ||
|
||
## 💀 **Additional context** | ||
|
||
- Add any additional context about the issue here. | ||
|
||
- **Include screenshots if needed**. | ||
|
||
- Keep in mind to stay problem-specific for issues, and solution-specific for PRs (unless its an ADR or BUG report). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,115 @@ | ||
--- | ||
name: Build | ||
about: Upgrade the build for this project | ||
title: "build(scope-of-PR): description of PR" | ||
labels: 'dependencies' | ||
assignees: '' | ||
--- | ||
|
||
# 🚩 Linked issue | ||
|
||
**Please remember to link the according issue here in this section with a [hyperlink](https://github.com/cuhacking/2025/issues).** This will give reviewers a chance to look to see what problem you are trying to solve. | ||
|
||
## 🛠 How does this PR address the issue(s)? How does it solve the problem? | ||
|
||
Showcase your implemented solution for the issue. Explain your additions/changes to the project | ||
|
||
## 🧠 Describe any alternatives you've considered | ||
|
||
Demonstrate why this is the correct/best solution specifically (in contrast to other solutions). | ||
|
||
## ✨ Dependency Changes (if applicable) | ||
|
||
If there are any dependency changes, list them here. | ||
|
||
## 📸 Before and After Screenshots (if applicable) | ||
|
||
| Before | After | | ||
| :-------------------: | :------------------: | | ||
| BEFORE IMAGES GO HERE | AFTER IMAGES GO HERE | | ||
|
||
## ✍️ Additional comments (if applicable) | ||
|
||
If there are any comments to add, list them here. | ||
|
||
# ✅ Checklist | ||
|
||
Make sure your PR follows the according checklist: | ||
|
||
### **Code Quality** | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>Done</th> | ||
<th>Checklist Item</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Code is clean and readable (functions used appropriately)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Code is commented appropriately (no unnecessary comments, follows guidelines)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Code is DRY (no repeated code)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Functions are named appropriately (camelCase)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Variables are named appropriately (camelCase)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Files are named appropriately (kebab-case)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Code performs as expected (no errors or issues when running)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>Code is committed and branched accordingly</td> | ||
</tr> | ||
</tbody> | ||
</table> | ||
|
||
### **PR Review Readiness** | ||
|
||
<table> | ||
<thead> | ||
<tr> | ||
<th>Done</th> | ||
<th>Checklist Item</th> | ||
</tr> | ||
</thead> | ||
<tbody> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>PR is linked to an issue (if applicable)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>PR is clear and comprehensible</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>PR is ready for review (if not, consider using a draft PR)</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>PR title follows template guidelines</td> | ||
</tr> | ||
<tr> | ||
<td><input type="checkbox" /></td> | ||
<td>PR description follows template guidelines</td> | ||
</tr> | ||
</tbody> | ||
</table> |
Oops, something went wrong.