Add a PR template and issue template #394
Conversation
Codecov ReportAll modified and coverable lines are covered by tests ✅
Additional details and impacted files@@ Coverage Diff @@
## main #394 +/- ##
==========================================
- Coverage 77.69% 77.66% -0.03%
==========================================
Files 49 49
Lines 10087 10076 -11
Branches 10087 10076 -11
==========================================
- Hits 7837 7826 -11
Misses 1805 1805
Partials 445 445 ☔ View full report in Codecov by Sentry. |
OussamaSaoudi-db
changed the title
|
|
||
|
|
||
| <!-- | ||
| Adapted from Apache Spark's pull request template: https://github.com/apache/spark |
There was a problem hiding this comment.
i think this was originally my suggestion :) but i meant for us to just credit them in the PR description or something - don't need to have it in the actual template
|
|
||
|
|
||
| <!-- | ||
| Adapted from Apache Spark's pull request template: https://github.com/apache/spark |
There was a problem hiding this comment.
i think this was originally my suggestion :) but i meant for us to just credit them in the PR description or something - don't need to have it in the actual template
| A clear and concise description of what you want to happen. | ||
| - type: textarea | ||
| attributes: | ||
| label: Describe alternatives you've considered |
| 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. |
|
Also can we make the 'user-facing changes' section of the PR description hidden by default with a comment that says 'uncomment if user-facing changes'? that way we don't just have tons of PRs with 'user-facing changes?' 'No.' |
Co-authored-by: Nick Lanham <nicklan@users.noreply.github.com> Co-authored-by: Zach Schuermann <zachary.zvs@gmail.com>
What changes were proposed in this pull request?
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?
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?
No
How was this change tested?
No way to test pull request templates or issue templates.