Skip to content

Commit 2194da2

Browse files
joedolsonjoedolson
committed
Add issue and PR templates.
1 parent 2ac07cf commit 2194da2

5 files changed

Lines changed: 140 additions & 0 deletions

File tree

‎.github/ISSUE_TEMPLATE/bug_report.md‎

Lines changed: 42 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,42 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**Version tested**
14+
Which version of AblePlayer are you reporting against?
15+
- Main (the current release)
16+
- Develop (the next release)
17+
- A specific branch other than main or develop.
18+
19+
**To Reproduce**
20+
Steps to reproduce the behavior:
21+
1. Go to '...'
22+
2. Click on '....'
23+
3. Scroll down to '....'
24+
4. See error
25+
26+
**Expected behavior**
27+
A clear and concise description of what you expected to happen.
28+
29+
**Screenshots**
30+
If applicable, add screenshots to help explain your problem.
31+
32+
**Desktop (please complete the following information):**
33+
- OS: [e.g. iOS]
34+
- Browser [e.g. chrome, safari]
35+
36+
**Smartphone (please complete the following information):**
37+
- Device: [e.g. iPhone6]
38+
- OS: [e.g. iOS8.1]
39+
- Browser [e.g. stock browser, safari]
40+
41+
**Additional context**
42+
Add any other context about the problem here.

‎.github/ISSUE_TEMPLATE/docs_existing.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Documentation (Existing)
3+
about: Edits to existing documentation needed
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**URL**
11+
page URL
12+
13+
**Title**
14+
Title of the existing documentation
15+
16+
**What Needs Editing?**
17+
Describe the steps using:
18+
1.
19+
2.
20+
3.
21+
22+
**Screenshots**
23+
If applicable, add screenshots for the above steps
24+
25+
**Additional context**
26+
Add any other context.

‎.github/ISSUE_TEMPLATE/docs_new.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
---
2+
name: Documentation (New)
3+
about: New documentation needed
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Title**
11+
Suggested title of the new documentation
12+
13+
**Description**
14+
Describe what the new page is about
15+
16+
**Instruction Steps**
17+
Describe the steps using:
18+
1.
19+
2.
20+
3.
21+
22+
**Screenshots**
23+
If applicable, add screenshots for the above steps
24+
25+
**Additional context**
26+
Add any other context.

‎.github/ISSUE_TEMPLATE/feature_request.md‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
**Is your feature request related to a problem? Please describe.**
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
13+
**Describe the solution you'd like**
14+
A clear and concise description of what you want to happen.
15+
16+
**Describe alternatives you've considered**
17+
A clear and concise description of any alternative solutions or features you've considered.
18+
19+
**Additional context**
20+
Add any other context or screenshots about the feature request here.

‎.github/PULL_REQUEST_TEMPLATE.md‎

Lines changed: 26 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,26 @@
1+
<!--
2+
BEFORE OPENING YOUR PULL REQUEST:
3+
- Make sure your Pull Request is being made against the `develop` branch of Able Player.
4+
- Make sure your code is properly documented.
5+
-->
6+
7+
## Description
8+
<!-- Please describe your changes -->
9+
<!-- Please provide a link to the issue this PR is intended to fix: -->
10+
11+
## How Has This Been Tested?
12+
<!-- Please describe in detail how you tested your changes. -->
13+
<!-- Include details of your testing environment, tests ran to see how -->
14+
<!-- your change affects other areas of the code, etc. -->
15+
16+
## Screenshots (jpeg or gifs if applicable):
17+
18+
## Types of changes
19+
<!-- What types of changes does your code introduce? -->
20+
<!-- Bug fix (non-breaking change which fixes an issue) -->
21+
<!-- New feature (non-breaking change which adds functionality) -->
22+
<!-- Breaking change (fix or feature that would cause existing functionality to not work as expected) -->
23+
24+
## Checklist:
25+
- [ ] My code is tested.
26+
- [ ] My code has proper inline documentation.

0 commit comments

Comments
 (0)