Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add templates for creating github issues #117

Merged
merged 1 commit into from
Oct 2, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
78 changes: 78 additions & 0 deletions .github/ISSUE_TEMPLATE/bug.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,78 @@
---
name: 🐞 Bug Report
about: File a bug report
title: 🐞 <Insert Title>
labels: bug
assignees: ''

---

### Checklist
In order to improve the time, how long a bugfix does take, please make sure you address as much as possible of the following checklist.

- [ ] I have reproduced the issue with at least the latest released version of \<PROJECT-NAME\>.
- [ ] I have added references to issues that sound similar.

**Tip: Adding screenshots, outputs and logs help to improve clarity.**

# Summary
<!---
Describe the bug: A clear and concise description of what the bug is.
-->

## Reproducing the Issue

Reproducibility: <pick one of> sporadic, regularly, always
<!---
Describe how to reproduce the bug, e.g.:
1. Go to '...'
2. Click on '....'
3. Scroll down to '....'
4. See error
-->
### Steps to reproduce the behavior:
1. <step 1>
2. <step 2>
3. ....

## Expected Behaviour
<!---
Describe the expected behaviour: A clear and concise description of what you expected to happen.
-->

## Actual Behaviour
<!---
Describe the actual observed behaviour: A clear and concise description of what you actually to happen.
Screenshot: If applicable, add screenshots to help explain your problem.
-->

## Root Cause (optional)
<!---
If known
-->


## Context
<!---
Describe the actual observed behaviour: A clear and concise description of what you observed.
Screenshot: If applicable, add screenshots to help explain your problem.
-->

### System
<!---
Describe the system and the used configuration.
-->
**Desktop:**
- OS: [e.g. Linux (Fedora 35), Linux (Ubuntu 20.01), MacOs (...), Windows (...)]
- Python Version [e.g. Python 3.8.0]
- Package Version [e.g. 22]

### Additional Context (optional)
<!---
Add any additional context about the problem here.
-->

#### Related Issues (optional)
<!---
Link related issues form the issue tracker here.
-->
41 changes: 41 additions & 0 deletions .github/ISSUE_TEMPLATE/documentation.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,41 @@
---
name: 📚 Documentation
about: Add/Improve Documentation
title: 📚 <Insert Title>
labels: documentation
assignees: ''

---

# Summary
<!---
A short summary on what of what needs to be documented or updated.
--->

# Details
<!---
A detailed description about what kind of documentation should be added and/or updated and why.
--->

## Background & Context
<!---
Why should this documentation be added/updated?

E.g.: Users are struggling to use this API and have repeatedly asked for some example code.
--->

## References
<!---
Further references to e.g. other information resources like links to specification(s), api docs etc.
--->

# Task(s)
<!---
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.

e.g.:
- [ ] Update documentation of XYZ
- [ ] Bump version number
- [ ] Update changelog
- [ ] ...
--->
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/feature.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: ✨ Feature
about: Add/Implement Feature
title: ✨ <Insert Title>
labels: feature
assignees: ''

---

# Summary
<!---
A short description of the feature (TL;DR)
--->

# Details
<!---
A detailed description about what should be added, background, links, context information
and usage example(s) of the feature.
--->

## Background & Context
<!---
What is the motivation for the feature?
Assessment of the feature. Pros & cons, solutions and decisions concerning the feature (reasoning).
--->

## Examples
<!---
Example usage(s) of the feature.
--->

## References
<!---
Further references to e.g. other information resources like links to specification(s) etc.
--->

# Task(s)
<!---
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.

e.g.:
- [ ] Add feature XYZ
- [ ] Bump version number
- [ ] Update documentation
- [ ] Update changelog
- [ ] ...
--->
15 changes: 15 additions & 0 deletions .github/ISSUE_TEMPLATE/other.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
---
name: 📝 Other Issue
about: Other Issue
title: 📝 <Insert Title>
labels: security
assignees: ''

---

# Summary
<!---
A short summary of the issue.
--->

# Details
47 changes: 47 additions & 0 deletions .github/ISSUE_TEMPLATE/refactoring.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,47 @@
---
name: 🔧 Refactoring
about: Refactor
title: 🔧 <Insert Title>
labels: refactoring
assignees: ''

---

# Summary
<!---
A short description of the planed refactoring (TL;DR)
--->

# Details
<!---
A detailed description about what and how it should be refactored, background, links, context information
and example(s) of how "the refactoring should look".
--->

## Background & Context
<!---
What is the motivation for the refactoring?
Assessment of the refactoring. Pros & cons, solutions and decisions concerning (reasoning) the refactoring.
--->

## Examples
<!---
Examples of how "the refactoring should look".
--->

## References
<!---
Further references to e.g. other information resources like links to specification(s) etc.
--->

# Task(s)
<!---
A task list containing common task associated with this kind of issue, but also tasks specific to this issue.

e.g.:
- [ ] Implement/Refactor XYZ
- [ ] Add tests for XYZ
- [ ] Bump version number
- [ ] Update changelog
- [ ] ...
--->
58 changes: 58 additions & 0 deletions .github/ISSUE_TEMPLATE/security.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,58 @@
---
name: 🔐 Security Issue
about: Fix Security Issue
title: 🔐 <Insert Title>
labels: security
assignees: ''

---

# Summary
<!---
A short summary of the security issue.
--->

| | |
|------------|-----|
| Class/Type | - |
| Version(s) | - |
| Severity | - |
| CVE Number | - |

<!---
A quick table based overview, containing the most important details.

Class/Type: Of vulnerability, e.g. xss, buffer-overflow, ... (see https://cwe.mitre.org/
Versions: Affected software versions
Severity: Of the vulnerability (Low, Medium, High, Critical)
CVE Number: number and link to the cve if available
-->


# Details

### Description
<!---
If no detailed information is available through references or CVE, an extensive
description of the vulnerability should be added here.
--->

### Impact
<!---
Describe the impact of the vulnerability.
--->

### References
<!---
Links to related issues or other sources like link to CVE.
--->

# Solutions
<!--
Describe possible solution(s), how to address this issue.
--->

# Credit
<!--
Whom to thank, kudos for the reporter(s)
-->