docs: add CONTRIBUTING guide for error-code and event conventions - #57
Merged
mikewheeleer merged 1 commit intoJun 24, 2026
Merged
Conversation
Co-Authored-By: Claude Opus 4.8 (1M context) <noreply@anthropic.com>
Contributor
|
good — documenting the error-code and event conventions will help every future PR. lgtm 🙌 |
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
CONTRIBUTING.mddocumenting the conventions that keep the escrow contract's ABI stable:EscrowErrortable reproduced exactly (codes 1..=12, reflecting that code 2RequestsMustBePositiveis also reused for a negative price). Next code must be 13.symbol_short!≤ 9-char event-topic constraint.usage/settled/pausedpayload shapes documented.unwrap_orgetter-default convention (andOptionwhen absence is meaningful).#[should_panic(expected = "Error(Contract, #N)")]— plus event/state assertion guidance.cargo fmt/cargo build/cargo testgate, and the 95%-coverage / 96-hour campaign expectations.Linked from
README.md. No code changed.Closes #46
Test output (gate, unchanged code)
Security notes: Docs-only change; no contract code or dependencies are modified. The error-code table is reproduced verbatim from
lib.rsso the documented ABI matches the implementation.