docs: add contributing guide for Soroban smart contracts - #192
Merged
snowrugar-beep merged 1 commit intoJul 17, 2026
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.
Closes #185
Description
Adds
contracts/CONTRIBUTING.mdwith Soroban-specific guidance that the rootCONTRIBUTING.mddoesn't cover.Problem: Root
CONTRIBUTING.mdonly references generic Conventional Commits — no guidance on how to add a new entry point, when to bump an error enum, where to add tests, or how to handle storage migrations.Solution: A dedicated
contracts/CONTRIBUTING.mdcovering the full smart-contract workflow for Stellar/Soroban contributors.Changes
Cargo.toml#[repr(u32)]sequential discriminants (start at 1, never reorder/remove, always append), common variants tabledomain/action/ optional entityid),symbol_short!rules (≤9 chars), data payload conventions, stable topic requirement#[cfg(test)] mod testspattern,setup_test_env()helper,#[should_panic(expected = "Error(Contract, #N)")]conventions with discriminant comments, CI pipeline referenceu128 → structupgrade walkthrough: deploy new contract, write tempmigrateentry point, run on testnet, remove after confirmation#[should_panic]tests), WASM build, deploymentHow to test