Skip to content

Commit

Permalink
Add a PR template and issue template (#394)
Browse files Browse the repository at this point in the history
<!--
Thanks for sending a pull request!  Here are some tips for you:
1. If this is your first time, please read our contributor guidelines:
https://github.com/delta-incubator/delta-kernel-rs/blob/main/CONTRIBUTING.md
  2. Ensure you have added or run the appropriate tests for your PR
3. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP]
Your PR title ...'.
  4. Be sure to keep the PR description updated to reflect all changes.
  5. Please write your PR title to summarize what this PR proposes.
6. If possible, provide a concise example to reproduce the issue for a
faster review.
-->

### What changes were proposed in this pull request?
<!--
Please clarify what changes you are proposing. The purpose of this
section is to outline the changes and how this PR fixes the issue.
If possible, please consider writing useful notes for better and faster
reviews in your PR.
-->
This PR adds a pull request template and issues template to the
repository.
The issues template is adapted from Apache Datafusion's issue template:
https://github.com/apache/datafusion/.
This pull request template is adapted from Apache Spark's pull request
template: https://github.com/apache/spark


### Why are the changes needed?
<!--
Please clarify why the changes are needed. If this is already explained
clearly in an issue, then this section is not needed.
1. If you propose a new API or feature, clarify the use case for a new
API or feature.
  2. If you fix a bug, you can clarify why it is a bug.
-->
A pull request template encourages open source contributions to clearly
state their purpose and approach. It explicitly calls out user facing
changes and explains why they are needed. It also encourages all
contributions to be well tested. In the event testing was difficult or
impossible, this exposes testing pain points can be addressed.

Issues template encourages community members and users to give all the
details that would help bugs get fixed and feature requests implemented.
Requiring more details from issues also helps newcomers to the project
get more context to get started contributing.

### Does this PR introduce _any_ user-facing change?
<!--
Note that it means *any* user-facing change including all aspects such
as the documentation fix.
If yes, please clarify the previous behavior and the change this PR
proposes - provide the console output, description and/or an example to
show the behavior difference if possible.
If possible, please also clarify if this is a user-facing change
compared to the released Spark versions or within the unreleased
branches such as master.
If no, write 'No'.
-->
No

### How was this change tested?
<!--
If tests were added, say they were added here. Please make sure to add
some test cases that check the changes thoroughly including negative and
positive cases if possible.
If it was tested in a way different from regular unit tests, please
clarify how you tested step by step, ideally copy and paste-able, so
that other reviewers can test and check, and descendants can verify in
the future.
If tests were not added, please describe why they were not added and/or
why it was difficult to add.
-->
No way to test pull request templates or issue templates.

<!--
This template was adapted from Apache Spark's pull request template:
https://github.com/apache/spark/tree/master
-->

---------

Co-authored-by: Nick Lanham <[email protected]>
Co-authored-by: Zach Schuermann <[email protected]>
  • Loading branch information
3 people authored Oct 24, 2024
1 parent e48d238 commit f5d0a42
Show file tree
Hide file tree
Showing 3 changed files with 80 additions and 0 deletions.
27 changes: 27 additions & 0 deletions .github/ISSUE_TEMPLATE/bug_report.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,27 @@
name: Bug report
description: Create a report to help us improve
labels: bug
body:
- type: textarea
attributes:
label: Describe the bug
placeholder: >
A clear and concise description of what the bug is.
validations:
required: true
- type: textarea
attributes:
label: To Reproduce
placeholder: >
Steps to reproduce the behavior:
- type: textarea
attributes:
label: Expected behavior
placeholder: >
What you expected to happen.
- type: textarea
attributes:
label: Additional context
placeholder: >
Add any other context about the problem here.
20 changes: 20 additions & 0 deletions .github/ISSUE_TEMPLATE/feature_request.yml
Original file line number Diff line number Diff line change
@@ -0,0 +1,20 @@
name: Feature request
description: Suggest an idea for this project
labels: enhancement
body:
- type: textarea
attributes:
label: Please describe why this is necessary.
placeholder: >
A description of what the problem is, or what motivates the feature you are requesting
- type: textarea
attributes:
label: Describe the functionality you are proposing.
placeholder: >
A clear and concise description of what you want to happen.
- type: textarea
attributes:
label: Additional context
placeholder: >
Add any other context or screenshots about the feature request here.
33 changes: 33 additions & 0 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,33 @@
<!--
Thanks for sending a pull request! Here are some tips for you:
1. If this is your first time, please read our contributor guidelines: https://github.com/delta-incubator/delta-kernel-rs/blob/main/CONTRIBUTING.md
2. Run `cargo t --all-features --all-targets` to get started testing, and run `cargo fmt`.
3. Ensure you have added or run the appropriate tests for your PR.
4. If the PR is unfinished, add '[WIP]' in your PR title, e.g., '[WIP] Your PR title ...'.
5. Be sure to keep the PR description updated to reflect all changes.
-->

## What changes are proposed in this pull request?
<!--
Please clarify what changes you are proposing and why the changes are needed.
The purpose of this section is to outline the changes, why they are needed, and how this PR fixes the issue.
If the reason for the change is already explained clearly in an issue, then it does not need to be restated here.
1. If you propose a new API or feature, clarify the use case for a new API or feature.
2. If you fix a bug, you can clarify why it is a bug.
-->

<!--
Uncomment this section if there are any changes affecting public APIs:
### This PR affects the following public APIs
If there are breaking changes, please ensure the `breaking-changes` label gets added by CI, and describe why the changes are needed.
Note that _new_ public APIs are not considered breaking.
-->


## How was this change tested?
<!--
Please make sure to add test cases that check the changes thoroughly including negative and positive cases if possible.
If it was tested in a way different from regular unit tests, please clarify how you tested, ideally via a reproducible test documented in the PR description.
-->

0 comments on commit f5d0a42

Please sign in to comment.