docs(contrib): add full contributor guide with architecture diagrams#31
Open
anshitraj wants to merge 3 commits intoomnuron:mainfrom
Open
docs(contrib): add full contributor guide with architecture diagrams#31anshitraj wants to merge 3 commits intoomnuron:mainfrom
anshitraj wants to merge 3 commits intoomnuron:mainfrom
Conversation
Closes the open documentation issue requesting a clearer map of the
repository and contribution paths for new contributors.
New files:
- docs/CONTRIBUTOR_GUIDE.md — 9-section contributor guide with:
- Annotated repo tree covering all 4 SDK surfaces
- Architecture overview (Python SDK / MCP / TypeScript / Control Plane)
- Payment execution flow (guard chain → route → Circle API)
- Contribution workflow (find issue → fork → code → PR → merge)
- Circle sandbox + Redis credential setup guide
- Local setup for Python SDK, MCP server, and TypeScript SDK
- Issue label guide and good-first-issue areas
- PR template, commit message conventions, branch naming
- Coding standards with real code examples
- What to avoid (payment-critical zones, credential safety)
- docs/img/architecture_overview.png
- docs/img/payment_flow.png
- docs/img/contribution_workflow.png
- docs/img/credentials_setup.png
Modified files:
- CONTRIBUTING.md — adds prominent link to new guide, fixes mcp_server/
path typo, adds TypeScript SDK and installable skills to project areas
Acceptance criteria satisfied:
- [x] Contributor guide explains repo areas
- [x] Local setup is documented (Python, MCP, TypeScript SDK)
- [x] Redis and Circle sandbox expectations are documented
- [x] Guidance exists for picking issues and opening PRs
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
1 participant
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 the open documentation issue requesting a clearer map of the repository and contribution paths for new contributors.
New files:
Modified files:
Acceptance criteria satisfied:
Closes #11