[ci] shorten Pull Request template by matthewdeng · Pull Request #57752 · ray-project/ray

matthewdeng · 2025-10-15T20:32:54Z

Description

Shortening the template per @edoakes' feedback.

Related issues

Follow-up to #57193.

Additional information

Made the following changes:

Removed Types of change and Checklist.
Updated contribution guide to point to Ray Docs.
Renamed Additional context to Additional information to be more encompassing.

Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

gemini-code-assist

Code Review

This pull request aims to shorten the pull request template. It updates the contribution guide link, removes the lengthy 'Types of change' and 'Checklist' sections, and renames 'Additional context' to 'Additional information'. The changes make the template more concise. I have one suggestion to retain the explicit check for breaking changes, as this is critical information that might be overlooked in a generic section.

gemini-code-assist · 2025-10-15T20:33:58Z

.github/PULL_REQUEST_TEMPLATE.md

+## Additional information

- [ ] Bug fix 🐛
- [ ] New feature ✨
- [ ] Enhancement 🚀
- [ ] Code refactoring 🔧
- [ ] Documentation update 📖
- [ ] Chore 🧹
- [ ] Style 🎨
-
-## Checklist
-
-**Does this PR introduce breaking changes?**
- [ ] Yes ⚠️
- [ ] No
-<!-- If yes, describe what breaks and how users should migrate -->
-
-**Testing:**
- [ ] Added/updated tests for my changes
- [ ] Tested the changes manually
- [ ] This PR is not tested ❌ _(please explain why)_
-
-**Code Quality:**
- [ ] Signed off every commit (`git commit -s`)
- [ ] Ran pre-commit hooks ([setup guide](https://docs.ray.io/en/latest/ray-contribute/getting-involved.html#lint-and-formatting))
-
-**Documentation:**
- [ ] Updated documentation (if applicable) ([contribution guide](https://docs.ray.io/en/latest/ray-contribute/docs.html))
- [ ] Added new APIs to `doc/source/` (if applicable)
-
-## Additional context
-
-<!-- Optional: Add screenshots, examples, performance impact, breaking change details -->
+<!-- Optional: Add implementation details, API changes, usage examples, screenshots, etc. -->


Simplifying the template is a great idea. However, removing the explicit check for breaking changes might lead to contributors forgetting to document them. This is a critical piece of information for reviewers and users. I'd suggest re-adding just that part of the checklist to ensure it's not missed. The 'Additional information' section is quite generic and might not be a strong enough prompt.

Suggested change

## Additional information

- [ ] Bug fix 🐛

- [ ] New feature ✨

- [ ] Enhancement 🚀

- [ ] Code refactoring 🔧

- [ ] Documentation update 📖

- [ ] Chore 🧹

- [ ] Style 🎨

## Checklist

**Does this PR introduce breaking changes?**

- [ ] Yes ⚠️

- [ ] No



**Testing:**

- [ ] Added/updated tests for my changes

- [ ] Tested the changes manually

- [ ] This PR is not tested ❌ _(please explain why)_

**Code Quality:**

- [ ] Signed off every commit (`git commit -s`)

- [ ] Ran pre-commit hooks ([setup guide](https://docs.ray.io/en/latest/ray-contribute/getting-involved.html#lint-and-formatting))

**Documentation:**

- [ ] Updated documentation (if applicable) ([contribution guide](https://docs.ray.io/en/latest/ray-contribute/docs.html))

- [ ] Added new APIs to `doc/source/` (if applicable)

## Additional context





## Additional information



---

**Does this PR introduce breaking changes?**

- [ ] Yes ⚠️

- [ ] No

cszhu

I kind of miss the "checklist for what changes" this is for (i.e. bug fix, new feature etc) but if the user is following the PR guidelines, then the commit should include that in the beginning with feat: or style:, so I guess it's fine. I can understand the desire for a simpler template too.

edoakes · 2025-10-15T20:39:08Z

.github/PULL_REQUEST_TEMPLATE.md

@@ -10,36 +10,6 @@

 <!-- Link related issues: "Fixes #1234", "Closes #1234", or "Related to #1234" -->


it'll make committers' lives easier if we make these regular text instead of comments

currently, people leave the comments in the description and then we have to manually go through and trim them out when committing the PR

if we make them regular text, then it'll be clear that they should overwrite/delete the prompts.

WDYT?

we can even say "edit or replace the text in the template" or something to make it very clear

sounds minor, but I probably spend like 30min a week doing this 😮‍💨

I completely understand. PTAL at the updated template. Looks like this now:

Thank you for contributing to Ray! 🚀
Please review the Ray Contribution Guide before opening a pull request.

⚠️ Remove these instructions before submitting your PR.

💡 Tip: Mark as draft if you want early feedback, or ready for review when it's complete.

Description

Briefly describe what this PR accomplishes and why it's needed.

Related issues

Link related issues: "Fixes #1234", "Closes #1234", or "Related to #1234".

Additional information

Optional: Add implementation details, API changes, usage examples, screenshots, etc.

Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to ray-project#57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to ray-project#57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com> Signed-off-by: xgui <xgui@anyscale.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to #57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com> Signed-off-by: elliot-barn <elliot.barnwell@anyscale.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to ray-project#57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to ray-project#57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com> Signed-off-by: Aydin Abiar <aydin@anyscale.com>

@edoakes

## Description Shortening the template per @edoakes' feedback. ## Related issues Follow-up to ray-project#57193. ## Additional information Made the following changes: 1. Removed `Types of change` and `Checklist`. 2. Updated contribution guide to point to Ray Docs. 3. Renamed `Additional context` to `Additional information` to be more encompassing. --------- Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com> Signed-off-by: Future-Outlier <eric901201@gmail.com>

matthewdeng added 2 commits October 15, 2025 13:29

[ci] shorten Pull Request template

d960f10

Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

newlines

861ae2d

Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

matthewdeng requested review from cszhu and edoakes October 15, 2025 20:32

gemini-code-assist bot reviewed Oct 15, 2025

View reviewed changes

cszhu approved these changes Oct 15, 2025

View reviewed changes

edoakes reviewed Oct 15, 2025

View reviewed changes

ray-gardener bot added docs An issue or change related to documentation core Issues that should be addressed in Ray Core devprod labels Oct 16, 2025

update

eda414b

Signed-off-by: Matthew Deng <matthew.j.deng@gmail.com>

edoakes approved these changes Oct 16, 2025

View reviewed changes

matthewdeng enabled auto-merge (squash) October 16, 2025 18:58

github-actions bot added the go add ONLY when ready to merge, run all tests label Oct 16, 2025

matthewdeng merged commit 068910f into ray-project:master Oct 16, 2025
8 checks passed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[ci] shorten Pull Request template#57752

[ci] shorten Pull Request template#57752
matthewdeng merged 3 commits intoray-project:masterfrom
matthewdeng:pr-template-fix

matthewdeng commented Oct 15, 2025 •

edited

Loading

Uh oh!

gemini-code-assist bot left a comment

Uh oh!

gemini-code-assist bot Oct 15, 2025

Uh oh!

cszhu left a comment

Uh oh!

edoakes Oct 15, 2025

Uh oh!

edoakes Oct 15, 2025

Uh oh!

edoakes Oct 15, 2025

Uh oh!

matthewdeng Oct 16, 2025

Uh oh!

edoakes Oct 16, 2025

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

		@@ -10,36 +10,6 @@

		<!-- Link related issues: "Fixes #1234", "Closes #1234", or "Related to #1234" -->

Conversation

matthewdeng commented Oct 15, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

Description

Related issues

Additional information

Uh oh!

gemini-code-assist bot left a comment

Choose a reason for hiding this comment

Code Review

Uh oh!

gemini-code-assist bot Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

cszhu left a comment

Choose a reason for hiding this comment

Uh oh!

edoakes Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

edoakes Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

edoakes Oct 15, 2025

Choose a reason for hiding this comment

Uh oh!

matthewdeng Oct 16, 2025

Choose a reason for hiding this comment

Description

Related issues

Additional information

Uh oh!

edoakes Oct 16, 2025

Choose a reason for hiding this comment

Uh oh!

Uh oh!

Reviewers

Assignees

Labels

Projects

Milestone

Development

Uh oh!

3 participants

matthewdeng commented Oct 15, 2025 •

edited

Loading