Skip to content

Commit

Permalink
docs: Created issue and pull request templates
Browse files Browse the repository at this point in the history
  • Loading branch information
IanTapply22 committed May 26, 2024
1 parent 2d47f46 commit 2141b1e
Show file tree
Hide file tree
Showing 3 changed files with 90 additions and 0 deletions.
33 changes: 33 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
---
name: Bug report
about: Something's wrong and it shouldn't be
title: "[BUG]"
labels: bug
assignees: ''

---

**Describe the bug**
A clear and concise description of what the bug is.

**To Reproduce**
Steps to reproduce the behaviour:
1. Load plugin
2. Do '...'
3. Something broke

**Expected behavior**
<br>
A clear and concise description of what you expected to happen.

**Media**
<br>
If applicable, add screenshots, pictures or videos to help explain your problem.

**Potential Resolution**
<br>
If you think you know what's causing the problem, mention it here. Otherwise, delete this section.

**Additional context**
<br>
Add any other context about the problem here.
24 changes: 24 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
---
name: Feature request
about: I can't do something and I want to
title: "[FEATURE]"
labels: enhancement
assignees: ''

---

**Problem Description**
<br>
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...], It should be easier to do [...]

**Desired Behaviour**
<br>
A clear and concise description of what you want to happen. Ex. When I [...], I want [...] to happen.

**Alternatives considered**
<br>
A clear and concise description of any alternative solutions or features you've considered, if any. Ex. Instead of [...], you could [...] instead.

**Additional context**
<br>
Add any other context about the feature request here.
33 changes: 33 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
# Description

Please include a summary of the changes and the related issue. Additionally, include relevant motivation and context. List any dependencies that are required for this change.

Fixes #(issue)

## Type of change

Please delete options that are not relevant.

- [ ] Bug fix (non-breaking change which fixes an issue)
- [ ] New feature (non-breaking change which adds functionality)
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
- [ ] This change requires a documentation update

# How Has This Been Tested?

Depending on the change, this may not be necessary. If so, please delete this section.

Please describe the tests that you ran to verify your changes. Provide instructions so we can reproduce. Please also list any relevant details for your test configuration.

- [ ] Test A
- [ ] Test B

# Checklist:

- [ ] My code follows the style guidelines of this project
- [ ] I have performed a self-review of my code
- [ ] I have commented my code, particularly in hard-to-understand areas
- [ ] I have made corresponding changes to the documentation, if any
- [ ] My changes generate no new warnings
- [ ] I have performed tests that prove my fix is effective or that my feature works, if necessary
- [ ] New and existing unit tests pass locally with my changes

0 comments on commit 2141b1e

Please sign in to comment.