Skip to content

docs: add code review guidelines and prompts for RIF Relay Contracts#174

Open
Hakob23 wants to merge 1 commit into
rsksmart:mainfrom
Hakob23:feat/FLY-2377
Open

docs: add code review guidelines and prompts for RIF Relay Contracts#174
Hakob23 wants to merge 1 commit into
rsksmart:mainfrom
Hakob23:feat/FLY-2377

Conversation

@Hakob23

@Hakob23 Hakob23 commented Jun 19, 2026

Copy link
Copy Markdown

What

  • Add .github/copilot-instructions.md to guide GitHub Copilot during code reviews.
  • Add .github/prompts/review-code.prompt.md with review areas and a structured feedback format.
  • Align with the pattern used in rif-relay-server, rif-relay-client, and sibling RSK repos, with contracts-specific checks (verifiers, EIP-712, fund safety, proxy/factory integrity, Hardhat testing).

Why

  • The repo had no Copilot or AI review guidance, while sibling RSK repos already use this pattern.
  • Contract changes define on-chain invariants consumed by client and server — incorrect verifier or EIP-712 changes can cause fund loss or broken signatures across the ecosystem.
  • Standardizes review expectations for both human reviewers and Copilot on PRs.

Refs

Jira Ticket

https://rsklabs.atlassian.net/browse/FLY-2377

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant