docs: add .ai-review/instructions.md for repo-specific review context - #357
Open
arshjafri-ripple wants to merge 3 commits into
Open
docs: add .ai-review/instructions.md for repo-specific review context#357arshjafri-ripple wants to merge 3 commits into
arshjafri-ripple wants to merge 3 commits into
Conversation
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.
Summary
Adds a
.ai-review/instructions.mdfile that the AI code reviewer reads before reviewing a pull request. It gives the reviewer context about how this crate actually works, so its comments reflect xrpl-rust's real conventions instead of generic Rust advice. This is a review-guidance file only: it changes no code and no runtime behavior, and it does not affect CI or block merges.Why
The reviewer is general-purpose. Without repo context it tends to miss the pitfalls specific to a financial SDK and, worse, flag intentional idioms as if they were bugs. This file encodes what a new senior reviewer would need to know before commenting on xrpl-rust, for example:
definitions.jsonhas no generator: it is hand-synced from xrpl.js/rippled, so fidelity to upstream is what needs checking, not the hand-edit itself.alloc/core, and theextern crate std as allocalias is intentional, not a typo.It also tells the reviewer which patterns are deliberate and should not be flagged (the standalone-node genesis credentials in tests, manual ledger advancement, test vectors ported byte-for-byte from xrpl.js).
What's in it
A short, high-signal list grouped by area:
The file is intentionally small so it fits the reviewer's context budget.
How it was built and checked
main: each cited file and symbol was opened and confirmed.Notes for reviewers