Skip to content

Commit

Permalink
feat: Add issue templates
Browse files Browse the repository at this point in the history
  • Loading branch information
caffeine-addictt committed Mar 13, 2024
1 parent 7741893 commit 9091b5c
Show file tree
Hide file tree
Showing 7 changed files with 362 additions and 0 deletions.
80 changes: 80 additions & 0 deletions .github/ISSUE_TEMPLATE/1-bug-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,80 @@
---
name: "Bug Report"
about: "Report an issue to help the project improve."
title: "[Bug] "
labels: "Type: Bug"
assignees: caffeine-addictt

---

# Bug report
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Expected Behavior
<!--
If you're describing a bug, tell us what should happen
If you're suggesting a change/improvement, tell us how it should work
Please include screenshots and/or code snippets if applicable
-->



## Current Behavior
<!--
If describing a bug, tell us what happens instead of the expected behavior
If suggesting a change/improvement, explain the difference from current behavior
Please include screenshots and/or code snippets if applicable
-->



## Is this a regression?
<!--
Did this behaviour use to work in previous versions?
If yes, what is the latest version where this behaviour is not present?
-->



## Possible Solution
<!--
Not obligatory, but suggest a fix/reason for the bug
or ideas how to implement the addition or change
-->



## Steps to Reproduce (for bugs)
<!--
Provide a link to a live example, or an unambiguous set of steps to reproduce this bug.
-->
1.
2.
3.
4.



## Context
<!--
How has this issue affected you?
What are you trying to accomplish?
Providing context helps us come up with a solution that is most useful in the real world.
Please include screenshots and/or code snippets if applicable
-->



## Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Operating System and version (desktop or mobile):
40 changes: 40 additions & 0 deletions .github/ISSUE_TEMPLATE/2-failing-test.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
---
name: "Failing Test"
about: "Report failing tests or CI jobs."
title: "[Test] "
labels: "Type: Test"
assignees: caffeine-addictt

---

# Failing Test
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Which Jobs/Tests are Failing?
*



## Reason for Failure
<!--
Why is/are this/these job/test(s) failing?
What are we missing to make it pass?
-->



## Media Prove
<!--
If applicable, add screenshots or code snippets to explain the issue
If not applicable, remove this field
-->



## Additional Context
<!--
Any other extra context or information
-->
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/3-docs-bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: "Documentation or README.md issue report"
about: "Report an issue in the project's documentation or README.md file."
title: ""
labels: "Documentation"
assignees: caffeine-addictt

---

# Documentation Issue Report
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Describe the Bug
<!--
A clear and concise description of the bug
-->



## Steps to Reproduce
<!--
e.g.:
1. Navigate to docs/x
2. Go to...
3. See error
-->

1.
2.
3.
4.



## Additional Context
<!--
Any other extra context or information
-->
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/4-feature-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: "Feature Request"
about: "Suggest an idea or possible new feature for this project."
title: ""
labels: "Type: Feature"
assignees: caffeine-addictt

---

# Feature Request
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Is Your Feature Request Related to an Issue?
<!--
If yes, provide a clear and concise description of what the problem is
E.g.:
Issue #
I'm always frustrated when...
-->



## Describe the Solution You'd Like
<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered
<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context
<!--
Any other extra context or information
-->
43 changes: 43 additions & 0 deletions .github/ISSUE_TEMPLATE/5-enhancement-request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,43 @@
---
name: "Enhancement Request"
about: "Suggest an enhancement for this project. Improve an existing feature"
title: ""
labels: "Type: Enhancement"
assignees: caffeine-addictt

---

# Enhancement Request
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Is Your Enhancement Request Related to an Issue?
<!--
If yes, provide a clear and concise description of what the problem is
E.g.:
Issue #
I'm always frustrated when...
-->



## Describe the Solution You'd Like
<!--
A clear and concise description of what you'd like
-->



## Describe Alternatives You've Considered
<!--
A clear and concise description of other alternatives you have considered
-->



## Additional Context
<!--
Any other extra context or information
-->
95 changes: 95 additions & 0 deletions .github/ISSUE_TEMPLATE/6-security-report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,95 @@
---
name: "Security Report"
about: "Report an issue to help the project improve."
title: ""
labels: "Type: Security"
assignees: caffeine-addictt

---

<!--
Oh, hi there! 😄
To expedite issue processing, please search open and closed issues before submitting a new one.
Please read our Rules of Conduct at this repository's `.github/CODE_OF_CONDUCT.md`
FIRST OF ALL, read this project's SECURITY.md file. Located in `.github/SECURITY.md`.
READ CAREFULLY IF YOUR ISSUE REPORT CONTAINS SENSIBLE OR PRIVATE DATA:
(data that might be leaked or subtracted from our servers due to this
security issue).
If this security report (or the guide on how to "identify the security bug") includes
certain personal information or involves personal identifiable data, or you believe
that the data that you might leak by exposing the way on how to attack the project
could be considered as a data leak or could violate the privacy of any kind of
data or sensible data, please do not post it here and directly email the developer:
([email protected]). You should post the issue with the least amount of
sensible or private data as possible to help us manage the security issue, and
with the extra data sent from your email to the developer (if any), we will deeply
analyze and try to fix it as fast as possible.
If you are in doubt about the data that you might post here (screenshots or media
also, count as data), please directly email us.
The data that must NOT be posted here:
* Legal and/or full names
* Names or usernames combined with other identifiers like phone numbers or email addresses
* Health or financial information (including insurance information, social security numbers, etc.)
* Information about political or religious affiliations
* Information about race, ethnicity, sexual orientation, gender, or other identifying information that could be used for discriminatory purposes
-->

# Security Report
Your issue may already be reported!
Please check out our [active issues](https://github.com/{{REPOSITORY}}/issues) before creating one.



## Describe the Security Issue
<!--
A clear and concise description of the security issue
-->



## Steps to Reproduce
<!--
e.g.:
1. Navigate to x
2. Go to...
3. See error
-->



## Expected Behavior
<!--
A clear and concise description of the expected behavior
-->



## Media Prove
<!--
If applicable, provide screenshots, videos and/or code snippets
-->



## Additional Context
<!--
Any other extra context or information
-->



### Your Environment
<!--
Include as many relevant details about the environment you experienced the bug in
-->
* Version used:
* Operating System and version (desktop or mobile):
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/7-question-support.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
---
name: "Question or Support Request"
about: "Questions and requests for support."
title: ""
labels: ["Type: Question", "help wanted"]
assignees: caffeine-addictt

---

# Question or Support Request




## Describe your question or ask for support
<!--
A clear and concise description of what your doubt is
-->

*

0 comments on commit 9091b5c

Please sign in to comment.