Skip to content

Commit 1924b92

Browse files
committed
Add PR/issue templates.
Make it easier for people to report issues.
1 parent 679fdda commit 1924b92

File tree

7 files changed

+145
-0
lines changed

7 files changed

+145
-0
lines changed
Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
---
2+
name: Bug report
3+
about: Something that's not right about the project
4+
title: ''
5+
labels: bug
6+
assignees: ''
7+
8+
---
9+
10+
## Problem statement
11+
12+
<!-- Explain what you think is wrong -->
13+
14+
15+
## Environment
16+
17+
<!-- Give details about the environment in which you are running, for
18+
example, the OS version, hardware, devices or applications that
19+
are related to the issue -->
20+
21+
22+
## Expected result
23+
24+
<!-- Explain what you expect to happen -->
25+
26+
27+
## Reproduction steps
28+
29+
<!-- Explain how to reproduce, or which test the failure is in -->
Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
name: Feature request
3+
about: Suggest an idea for this project
4+
title: ''
5+
labels: enhancement
6+
assignees: ''
7+
8+
---
9+
10+
## Is your feature request related to a problem?
11+
12+
<!-- Give a clear description of what you're trying to address with
13+
this request.
14+
For example, "I'm always frustrated when [...]",
15+
"It is hard to [...]"
16+
-->
17+
18+
## Describe the solution you'd like
19+
20+
<!-- Give a clear description of how you the request might be
21+
addressed. If you have ideas about how it could be implemented,
22+
separate them from user interface changes.
23+
-->
24+
25+
## Additional context
26+
27+
<!-- If you have some context, like places where this would have
28+
helped, screenshots or mock ups of an interface, or the sort
29+
of results you'd like to see, include them here.
30+
-->

.github/pull_request_template.md

Lines changed: 17 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,17 @@
1+
# Changes
2+
3+
<!-- Describe the changes you've made in this section.
4+
Try to explain why they're needed and what they do.
5+
Your reviewers will use this to decide whether the
6+
change is sufficient and correct.
7+
You can include pictures or diagrams in here
8+
(see mermaid documentation on GitHub).
9+
-->
10+
11+
# Testing
12+
13+
<!-- Describe the testing you have done manually to
14+
satisfy yourself that the change works as intended.
15+
If automated tests have been updated, state this.
16+
Include output or pictures if necessary.
17+
-->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Problem statement
2+
3+
<!-- Explain what you think is wrong -->
4+
5+
6+
## Environment
7+
8+
<!-- Give details about the environment in which you are running, for
9+
example, the OS version, hardware, devices or applications that
10+
are related to the issue -->
11+
12+
13+
## Expected result
14+
15+
<!-- Explain what you expect to happen -->
16+
17+
18+
## Reproduction steps
19+
20+
<!-- Explain how to reproduce, or which test the failure is in -->
Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
## Problem statement
2+
3+
<!-- Explain what you think is wrong -->
4+
5+
6+
## Environment
7+
8+
<!-- Give details about the environment in which you are running, for
9+
example, the OS version, hardware, devices or applications that
10+
are related to the issue -->
11+
12+
13+
## Expected result
14+
15+
<!-- Explain what you expect to happen -->
16+
17+
18+
## Reproduction steps
19+
20+
<!-- Explain how to reproduce, or which test the failure is in -->
Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
# Changes
2+
3+
<!-- Describe the changes you've made in this section.
4+
Try to explain why they're needed and what they do.
5+
Your reviewers will use this to decide whether the
6+
change is sufficient and correct.
7+
You can include pictures or diagrams in here
8+
(see mermaid documentation on GitHub).
9+
-->
10+
11+
%{first_multiline_commit_description}
12+
13+
# Testing
14+
15+
<!-- Describe the testing you have done manually to
16+
satisfy yourself that the change works as intended.
17+
If automated tests have been updated, state this.
18+
Include output or pictures if necessary.
19+
-->

CODEOWNERS

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,10 @@
1+
##
2+
# CODEOWNERS - define who is responsible for parts of the sources
3+
#
4+
# See:
5+
# https://docs.github.com/en/repositories/managing-your-repositorys-settings-and-features/customizing-your-repository/about-code-owners
6+
# https://docs.gitlab.com/user/project/codeowners/reference/
7+
#
8+
9+
# Default code owners - automatically assigned for reviews
10+
* @gerph

0 commit comments

Comments
 (0)