Skip to content

Add pull-request template #1777

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
kevinjqliu merged 4 commits into from
Mar 15, 2025
Merged

Add pull-request template #1777

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
b7fe332
Add pull-request template
Fokko Mar 8, 2025
b461488
Exclude from RAT
Fokko Mar 8, 2025
9c7f136
Does this work?
Fokko Mar 12, 2025
866f96c
Update how to guide
Fokko Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 14 additions & 0 deletions .github/pull_request_template.md
View file
Open in desktop
Copy link
Contributor

@kevinjqliu kevinjqliu Mar 11, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Need the Apache license headers in the file.

Copy link
Contributor Author

@Fokko Fokko Mar 12, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we don't include the .github/* directory in the source release tar, we can ignore this. I don't like that people have to scroll across the license.

image

Original file line number Diff line number Diff line change
@@ -0,0 +1,14 @@
<!--
Thanks for opening a pull request!
-->

<!-- In the case this PR will resolve an issue, please replace ${GITHUB_ISSUE_ID} below with the actual Github issue id. -->
<!-- Closes #${GITHUB_ISSUE_ID} -->

# Rationale for this change

# Are these changes tested?

# Are there any user-facing changes?

<!-- In the case of user-facing changes, please add the changelog label. -->
1 change: 1 addition & 0 deletions dev/.rat-excludes
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,3 +1,4 @@
.github/*
Copy link
Member

@hussein-awala hussein-awala Mar 13, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It's very strange, how .github/* worked and .github/pull_request_template.md didn't 🤔

.rat-excludes
build
.git
Expand Down
2 changes: 2 additions & 0 deletions mkdocs/docs/how-to-release.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -379,6 +379,8 @@ Then, select the previous release version as the **Previous tag** to use the dif

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

Make sure to check the `changelog` label on GitHub to see if anything needs to be highlighted.

### Release the docs

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