Skip to content

Commit b1d3da6

Browse files
authored
add templates (#2)
Co-authored-by: ahacke <ahacke@users.noreply.github.com>
1 parent 2a6a44f commit b1d3da6

File tree

4 files changed

+90
-0
lines changed

4 files changed

+90
-0
lines changed

.github/ISSUE_TEMPLATE/bug_report.md

+40
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
---
2+
name: 🐞 Bug
3+
about: File a bug/issue
4+
title: '<title>'
5+
labels: Bug, Needs Triage
6+
assignees: ''
7+
8+
---
9+
10+
<!--
11+
Note: Please search to see if an issue already exists for the bug you encountered.
12+
-->
13+
14+
### Current Behavior:
15+
<!-- A concise description of what you're experiencing. -->
16+
17+
### Expected Behavior:
18+
<!-- A concise description of what you expected to happen. -->
19+
20+
### Steps To Reproduce:
21+
<!--
22+
Example: steps to reproduce the behavior:
23+
1. In this environment...
24+
1. With this config...
25+
1. Run '...'
26+
1. See error...
27+
-->
28+
29+
### Environment:
30+
<!--
31+
Example:
32+
- OS: Ubuntu 20.04
33+
- Node: 13.14.0
34+
- npm: 7.6.3
35+
-->
36+
37+
### Anything else:
38+
<!--
39+
Links? References? Anything that will give us more context about the issue that you are encountering!
40+
-->

.github/ISSUE_TEMPLATE/config.yml

+1
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
blank_issues_enabled: false
+17
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
---
2+
name: 🚀 Feature
3+
about: Propose a new feature
4+
title: '<title>'
5+
labels: feature
6+
assignees: ''
7+
8+
---
9+
10+
### Summary
11+
<!--
12+
One paragraph explanation of the feature.
13+
-->
14+
### Motivation
15+
<!--
16+
Why is this feature of general interest?
17+
-->

.github/pull_request_template.md

+32
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
# Description
2+
3+
_Please include a summary of the changes and the related issue. Please also include relevant motivation and context. List any dependencies that are required for this change._
4+
5+
Fixes # (issue)
6+
7+
## Type of change
8+
9+
_Please delete options that are not relevant._
10+
11+
- [ ] Bug fix (non-breaking change which fixes an issue)
12+
- [ ] New feature (non-breaking change which adds functionality)
13+
- [ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)
14+
- [ ] This change requires a documentation update
15+
16+
# How Has This Been Tested?
17+
18+
_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_
19+
20+
- [ ] Test A
21+
- [ ] Test B
22+
23+
# Checklist:
24+
25+
- [ ] My code follows the style guidelines of this project
26+
- [ ] I have performed a self-review of my code
27+
- [ ] I have commented my code, particularly in hard-to-understand areas
28+
- [ ] I have made corresponding changes to the documentation
29+
- [ ] My changes generate no new warnings
30+
- [ ] I have added tests that prove my fix is effective or that my feature works
31+
- [ ] New and existing unit tests pass locally with my changes
32+
- [ ] Any dependent changes have been merged and published in downstream modules

0 commit comments

Comments
 (0)