Skip to content

Commit fe7dc7d

Browse files
authored
docs: add commit message formatting guidelines to AGENTS.md (JuliaLang#58629)
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.
1 parent edb2aa8 commit fe7dc7d

File tree

1 file changed

+14
-0
lines changed

1 file changed

+14
-0
lines changed

AGENTS.md

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -51,6 +51,17 @@ corresponding test to ensure that the test is still passing with your changes.
5151
- Write one comment at the top of the test to explain what is being tested.
5252
Otherwise keep comments minimal.
5353

54+
### External dependencies
55+
56+
When modifying external dependencies (patches in `deps/patches/` or version updates in `deps/`):
57+
58+
1. Always test builds with `USE_BINARYBUILDER=0` to ensure source builds work correctly
59+
2. For patches to external libraries:
60+
- Verify the patch applies cleanly by running the extraction and patch steps
61+
- Test the full build of the dependency: `make -C deps USE_BINARYBUILDER=0 compile-<depname>`
62+
- Prefer using the full upstream commit in `git am` format (e.g., `git format-patch`) which includes proper commit metadata
63+
3. When updating dependency versions, ensure all associated patches still apply
64+
5465
### Writing code
5566
After writing code, look up the docstring for each function you used. If there
5667
are recommendations or additional considerations that apply to these functions,
@@ -69,6 +80,9 @@ documentation, etc., unless this is the main purpose of the change. Do not menti
6980
the test plan, unless it differs from what you were instructed to do in AGENTS.md.
7081
If your change fixes one or more issues, use the syntax "Fixes #" at the end of the commit message, but do not include it in the title.
7182

83+
When referencing external GitHub PRs or issues, use proper GitHub interlinking format (e.g., `owner/repo#123` for PRs/issues).
84+
When fixing CI failures, include the link to the specific CI failure in the commit message.
85+
7286
When creating pull requests, if the pull request consists of one commit only,
7387
use the body of the commit for the body of the pull request. If there are multiple
7488
commits in the pull request, follow the same guidelines for the pull request

0 commit comments

Comments
 (0)