docs: document the pull request title convention#86
Merged
Conversation
Reefact
changed the title
Commit messages had a convention; pull request titles had only "write it in English". State the rule where the reviewer and the template can point to it: the title names the whole request, mirrors the commit header when the branch carries one intention, and uses a plain descriptive title when it carries several, with issue references kept in the description. Co-Authored-By: Claude Opus 4.8 <noreply@anthropic.com> Claude-Session: https://claude.ai/code/session_01S4XHakMTBzuDo9C3Pnjbm5
Reefact
force-pushed
the
claude/pr-title-conventions-2sykyf
branch
from
fe9b562 to
814e400
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
This PR documents the conventions for pull request titles in the project, establishing clear guidance on how to title PRs based on their scope and intent. It updates the contributor guide, PR template, and project conventions file.
Type of change
Changes
CONTRIBUTING.mdwith:.github/pull_request_template.mdto reference the new PR title conventions and clarify where issue links belongCLAUDE.mdto instruct on following the new PR title conventions fromCONTRIBUTING.mdTesting
Documentation
doc/updatedRelated issues
https://claude.ai/code/session_01S4XHakMTBzuDo9C3Pnjbm5