Skip to content

Commit 9351db4

Browse files
committed
docs: add GitHub issue and PR templates
1 parent 757a078 commit 9351db4

3 files changed

Lines changed: 95 additions & 0 deletions

File tree

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,28 @@
1+
name: Bug report
2+
description: Create a report to help us improve
3+
type: Bug
4+
labels: bug
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Describe the bug
9+
description: Describe the bug.
10+
placeholder: >
11+
A clear and concise description of what the bug is.
12+
validations:
13+
required: true
14+
- type: textarea
15+
attributes:
16+
label: To Reproduce
17+
placeholder: >
18+
Steps to reproduce the behavior:
19+
- type: textarea
20+
attributes:
21+
label: Expected behavior
22+
placeholder: >
23+
A clear and concise description of what you expected to happen.
24+
- type: textarea
25+
attributes:
26+
label: Additional context
27+
placeholder: >
28+
Add any other context about the problem here.
Lines changed: 27 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,27 @@
1+
name: Feature request
2+
description: Suggest an idea for this project
3+
type: Feature
4+
labels: enhancement
5+
body:
6+
- type: textarea
7+
attributes:
8+
label: Is your feature request related to a problem or challenge?
9+
description: Please describe what you are trying to do.
10+
placeholder: >
11+
A clear and concise description of what the problem is. Ex. I'm always frustrated when [...]
12+
(This section helps DataFusion developers understand the context and *why* for this feature, in addition to the *what*)
13+
- type: textarea
14+
attributes:
15+
label: Describe the solution you'd like
16+
placeholder: >
17+
A clear and concise description of what you want to happen.
18+
- type: textarea
19+
attributes:
20+
label: Describe alternatives you've considered
21+
placeholder: >
22+
A clear and concise description of any alternative solutions or features you've considered.
23+
- type: textarea
24+
attributes:
25+
label: Additional context
26+
placeholder: >
27+
Add any other context or screenshots about the feature request here.

‎.github/pull_request_template.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
## Which issue does this PR close?
2+
3+
<!--
4+
We generally require a GitHub issue to be filed for all bug fixes and enhancements and this helps us generate change logs for our releases. You can link an issue to this PR using the GitHub syntax. For example `Closes #123` indicates that this PR will close issue #123.
5+
-->
6+
7+
- Closes #.
8+
9+
## Rationale for this change
10+
11+
<!--
12+
Why are you proposing this change? If this is already explained clearly in the issue then this section is not needed.
13+
Explaining clearly why changes are proposed helps reviewers understand your changes and offer better suggestions for fixes.
14+
-->
15+
16+
## What changes are included in this PR?
17+
18+
<!--
19+
There is no need to duplicate the description in the issue here but it is sometimes worth providing a summary of the individual changes in this PR.
20+
-->
21+
22+
## Are these changes tested?
23+
24+
<!--
25+
We typically require tests for all PRs in order to:
26+
1. Prevent the code from being accidentally broken by subsequent changes
27+
2. Serve as another way to document the expected behavior of the code
28+
29+
If tests are not included in your PR, please explain why (for example, are they covered by existing tests)?
30+
-->
31+
32+
## Are there any user-facing changes?
33+
34+
<!--
35+
If there are user-facing changes then we may require documentation to be updated before approving the PR.
36+
-->
37+
38+
<!--
39+
If there are any breaking changes to public APIs, please add the `api change` label.
40+
-->

0 commit comments

Comments
 (0)