Skip to content

Commit 1c0e2b0

Browse files
authored
Add pull-request template (#1777)
While @kevinjqliu did an amazing job summarizing the new stuff in 0.9.0 in the GitHub release (https://github.com/apache/iceberg-python/releases/tag/pyiceberg-0.9.0), I think it would be good to formalize this a bit. This also came up in #1669 where we introduced a behavioral change. cc @sungwy I think it would be good to allow users to populate the changelog section to ensure they know about any relevant changes. The template is pretty minimal now to avoid being a big barrier to opening a PR.
1 parent eeb6d14 commit 1c0e2b0

File tree

3 files changed

+17
-0
lines changed

3 files changed

+17
-0
lines changed

.github/pull_request_template.md

+14
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,14 @@
1+
<!--
2+
Thanks for opening a pull request!
3+
-->
4+
5+
<!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
6+
<!-- Closes #${GITHUB_ISSUE_ID} -->
7+
8+
# Rationale for this change
9+
10+
# Are these changes tested?
11+
12+
# Are there any user-facing changes?
13+
14+
<!-- In the case of user-facing changes, please add the changelog label. -->

dev/.rat-excludes

+1
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
.github/*
12
.rat-excludes
23
build
34
.git

mkdocs/docs/how-to-release.md

+2
Original file line numberDiff line numberDiff line change
@@ -379,6 +379,8 @@ Then, select the previous release version as the **Previous tag** to use the dif
379379

380380
**Set as the latest release** and **Publish**.
381381

382+
Make sure to check the `changelog` label on GitHub to see if anything needs to be highlighted.
383+
382384
### Release the docs
383385

384386
Run the [`Release Docs` Github Action](https://github.com/apache/iceberg-python/actions/workflows/python-release-docs.yml).

0 commit comments

Comments
 (0)