Update PR template given we now use it for commit descriptions. #2419
Conversation
We automatically run pre-commit lints and tests, so the checklist feels superfluous.
There was a problem hiding this comment.
Pull request overview
This PR updates the pull request template to better align with current practices, specifically reflecting that code is now auto-tested and encouraging more concise descriptions suitable for commit messages.
Changes:
- Removed the checklist section (linting, testing, deletion reminder) since these steps are now automated
- Added guidance requesting concise, paragraph-length descriptions with optional bullet points
- Included a concrete example showing the preferred format and style for PR descriptions
.github/PULL_REQUEST_TEMPLATE.md
Outdated
| [Please include a summary of the changes and the related issue.] | ||
| e.g. | ||
|
|
||
| Title: [RL] Fix loss: use global token normalization instead of per-example (#2376) |
There was a problem hiding this comment.
The example title includes a specific PR number (#2376) which will become outdated and confusing as a template example. Consider using a generic placeholder like "(#XXXX)" or removing the PR number entirely from the example.
| Title: [RL] Fix loss: use global token normalization instead of per-example (#2376) | |
| Title: [RL] Fix loss: use global token normalization instead of per-example (#XXXX) |
|
@claude adjust this template to provide a place for an appropriate #fixes notation. Add a note which the user should delete indicating that the PR should reference an existing issue for ongoing work. |
|
Claude finished @rjpower's task in 51s —— View job Task: Update PR Template for Issue ReferencesSuccessfully updated the PR template to include issue reference notation. Todo List
Changes MadeAdded to the top of the PR template:
The template now starts with: Fixes #This addresses the feedback from Helw150's review comment and provides clear guidance for users while maintaining the concise format you wanted. --- | |
- Added 'Fixes #' placeholder for issue references (enables auto-close) - Added deletable comment reminding users to reference existing issues - Addresses feedback from review comments Co-authored-by: Russell Power <rjpower@users.noreply.github.com>
Updated the pull request template to improve clarity and structure.
dlwh
left a comment
dlwh
left a comment
There was a problem hiding this comment.
maybe have agents.md link to this? people are using agents to write their pr descriptions now
|
sorry was on auto-merge, can add agents update separately |
This updates our PR template to reflect that we now auto-test all code and prefer to have concise descriptions.