Docs: Require purpose prefixes for PRs and commits#1013
Open
brandonpayton wants to merge 1 commit into
Open
Conversation
Make Area: Purpose the repository convention for PR titles and commit subjects, with contract-oriented examples and cross-cutting guidance.
|
prepare-merge: no package or runtime-affecting changes; package staging and durable package publishing were skipped. |
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
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.
Why
PR titles and commit subjects are often the first—and sometimes only—context a developer sees while scanning CI, release history, or a long pull-request list. A mechanically worded title can make it hard for a junior developer to tell whether a change affects the kernel, POSIX behavior, Homebrew, CI, or documentation.
This change gives every title a short routing hint while preserving the existing requirement to explain the actual purpose of the work.
What changed
Area: Purposeshape for PR titles and commit subjects.Homebrew:,Kernel:,POSIX:,CI:, andDocs:.Contract scope
This is agent and contributor guidance only. It does not change runtime behavior, ABI, package artifacts, CI enforcement, Node.js behavior, or browser behavior.
Validation
git diff --check origin/main...HEADRuntime and browser suites were not run because this PR only changes Markdown guidance.