docs: add commit message formatting guidelines to AGENTS.md#58629
Merged
docs: add commit message formatting guidelines to AGENTS.md#58629
Conversation
Add two additional guidelines for commit message formatting: - When referencing external GitHub PRs or issues, use proper GitHub interlinking format (e.g., owner/repo#123) - When fixing CI failures, include the link to the specific CI failure in the commit message These guidelines help improve commit message clarity and traceability.
Member
|
I think these instructions are totally reasonable for human beings, too. |
Member
Author
|
Yeah, but the AI actually reads docs ;) |
Add guidance for modifying external dependencies, including: - Testing with USE_BINARYBUILDER=0 to ensure source builds work - Verifying patches apply cleanly and dependencies build successfully - Preferring full upstream commits in git am format for proper metadata - Ensuring patches still apply when updating dependency versions These steps help prevent build failures in environments that build from source rather than using prebuilt binaries.
Member
Author
|
Updated this PR to tell the AI to test its deps changes to avoid a recurrence of #58628 (comment). |
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.
Add two additional guidelines for commit message formatting:
interlinking format (e.g., owner/repo#123)
in the commit message
These guidelines help improve commit message clarity and traceability.