Skip to content
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

Jump to bottom

GH-23: Add PR template #164

Merged
merged 3 commits into from
Oct 26, 2024
Merged

GH-23: Add PR template #164

merged 3 commits into from
Oct 26, 2024

Conversation

zeroshade
Copy link
Member

Fixes #23

@zeroshade zeroshade requested a review from kou October 17, 2024 18:29
kou
kou reviewed Oct 17, 2024
View reviewed changes
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

We need Fixes #XXX in PR description because we don't use a merge script.

.github/pull_request_template.md Outdated
@@ -0,0 +1,60 @@
<!--
Copy link
Member

Choose a reason for hiding this comment

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

How about using raw text instead of comment text?

It seems that most developers don't remove comment in pull request template.
In apache/arrow, we remove comments in our merge script https://github.com/apache/arrow/blob/0c3206772051c52fe2e648623daaca2c4e71cb72/dev/merge_arrow_pr.py#L603-L604 but we don't use merge script in apache/arrow-go. So our commit history have many this comments...

If we use raw text instead of comment text, we can notice it before we use the merge button. We can remove needless texts before we merge.

@zeroshade
Copy link
Member Author

@kou how about a simple template with just the headings? I think we can give enough faith in developers to understand the sections without worrying about them having to remember to delete sample text?

kou
kou approved these changes Oct 26, 2024
View reviewed changes
Copy link
Member

@kou kou left a comment

Choose a reason for hiding this comment

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

+1

Let's try the approach!

@zeroshade zeroshade merged commit 80f4e33 into apache:main Oct 26, 2024
24 checks passed
@zeroshade zeroshade deleted the add-pr-template branch October 26, 2024 15:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@kou kou kou approved these changes

@assignUser assignUser Awaiting requested review from assignUser assignUser is a code owner

@raulcd raulcd Awaiting requested review from raulcd raulcd is a code owner

Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add pull request template
2 participants
@zeroshade @kou