docs(agents): symlink editing rule, crates.io UA, jq optional chaining - #139
Merged
Merged
Conversation
Signed-off-by: Sebastian Mendel <sebastian.mendel@netresearch.de>
|
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
1 similar comment
Contributor
Dependency Review✅ No vulnerabilities or license issues or OpenSSF Scorecard issues found.Scanned FilesNone |
There was a problem hiding this comment.
🟢 Ready to approve
Documentation-only updates are clear, correctly formatted, and consistent with the PR description.
This review doesn't count toward merge requirements. Sign up for the private preview to control whether Copilot approvals count.
Pull request overview
Promotes three operational/documentation learnings into the repository’s root AGENTS.md to improve contributor guidance around editing agent instructions and handling external API/jq edge cases.
Changes:
- Documented that
CLAUDE.mdis a symlink toAGENTS.mdand must not be edited directly. - Added external API guidance covering crates.io’s User-Agent requirement and jq optional-chaining to avoid null-array iteration failures.
File summaries
| File | Description |
|---|---|
| AGENTS.md | Adds contributor guidance on symlinked instruction files and external API/jq robustness gotchas. |
Review details
- Files reviewed: 1/1 changed files
- Comments generated: 0
- Review effort level: Lite
We're testing this review assessment. Please use 👍 or 👎 to tell us if it's correct.
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.
What
Three promoted learnings (
/retro promote, batch 4) intoAGENTS.md:CLAUDE.mdis a symlink toAGENTS.md(root and scoped) — edit the resolved target; editing the symlink fails the Edit-tool guard.-A, and note the package-version MCP has no crates coverage..arr[]?) over external API JSON — a null array otherwise aborts the whole pipeline.The deps-vs-system-upgrade note from the same batch is already covered by "Project maintenance vs. tool feature" and was tombstoned without an upward write.
Came from /retro: yes