Skip to content

Commit a73f6cf

Browse files
committed
📝 Add Issues and PR template
1 parent 9bc31ea commit a73f6cf

File tree

4 files changed

+110
-0
lines changed

4 files changed

+110
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

Lines changed: 35 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,35 @@
1+
---
2+
name: Bug report
3+
about: Create a report to help us improve
4+
title: "[Bug]"
5+
labels: bug
6+
assignees: tiago18c, murlokito
7+
8+
---
9+
10+
**Describe the bug**
11+
A clear and concise description of what the bug is.
12+
13+
**To Reproduce**
14+
Steps to reproduce the behavior:
15+
16+
17+
**Expected behavior**
18+
A clear and concise description of what you expected to happen.
19+
20+
**Screenshots**
21+
If applicable, add screenshots to help explain your problem.
22+
23+
**Desktop (please complete the following information):**
24+
- OS: [e.g. iOS]
25+
- Browser [e.g. chrome, safari]
26+
- Version [e.g. 22]
27+
28+
**Smartphone (please complete the following information):**
29+
- Device: [e.g. iPhone6]
30+
- OS: [e.g. iOS8.1]
31+
- Browser [e.g. stock browser, safari]
32+
- Version [e.g. 22]
33+
34+
**Additional context**
35+
Add any other context about the problem here.

.github/ISSUE_TEMPLATE/custom.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
---
2+
name: Custom issue template
3+
about: Describe this issue template's purpose here.
4+
title: ''
5+
labels: ''
6+
assignees: ''
7+
8+
---
9+
10+
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: 45 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,45 @@
1+
2+
> ⚠️ NOTE: Use notes like this to emphasize something important about the PR.
3+
>
4+
> This could include other PRs this PR is built on top of; API breaking changes; reasons for why the PR is on hold; or anything else you would like to draw attention to.
5+
6+
| Status | Type | ⚠️ Core Change | Issue |
7+
| :---: | :---: | :---: | :--: |
8+
| Ready/Hold | Feature/Bug/Tooling/Refactor/Hotfix | Yes/No | [Link](<Issue link here>) |
9+
10+
## Problem
11+
12+
_What problem are you trying to solve?_
13+
14+
15+
## Solution
16+
17+
_How did you solve the problem?_
18+
19+
20+
## Before & After Screenshots
21+
22+
_Insert screenshots of example code output_
23+
24+
**BEFORE**:
25+
[insert screenshot here]
26+
27+
**AFTER**:
28+
[insert screenshot here]
29+
30+
31+
## Other changes (e.g. bug fixes, small refactors)
32+
33+
34+
## Deploy Notes
35+
36+
_Notes regarding deployment of the contained body of work. These should note any
37+
new dependencies, new scripts, etc._
38+
39+
**New scripts**:
40+
41+
- `script` : script details
42+
43+
**New dependencies**:
44+
45+
- `dependency` : dependency details

0 commit comments

Comments
 (0)