Skip to content

docs(contrib): add full contributor guide with architecture diagrams #31

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
anshitraj wants to merge 3 commits into
base: main
Choose a base branch
from
Open

docs(contrib): add full contributor guide with architecture diagrams #31

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
09490dc
docs(contrib): add full contributor guide with architecture diagrams
anshitraj Apr 3, 2026
b663ae6
Merge branch 'main' into docs/contributor-guide
anshitraj Apr 6, 2026
01835ea
Merge branch 'main' into docs/contributor-guide
anshitraj Apr 16, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 9 additions & 2 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,12 @@

Thank you for contributing to OmniClaw.

This repository contains the Python SDK as the primary product surface, along with supporting docs, examples, and an optional MCP server.
> **New here?** Read the full **[Contributor Guide](docs/CONTRIBUTOR_GUIDE.md)** first.
> It covers the repo map, local setup, Circle sandbox credentials, Redis,
> how to pick an issue, and how to open a good PR.

This file is a short reference summary. The detailed guide lives in
[`docs/CONTRIBUTOR_GUIDE.md`](docs/CONTRIBUTOR_GUIDE.md).

## Project Areas

Expand All @@ -12,7 +17,9 @@ Main contribution areas:
- SDK tests in `tests/`
- docs in `docs/`
- examples in `examples/`
- MCP server in `mcp-server/`
- MCP server in `mcp_server/`
- TypeScript / npm SDK in `npm/omniclaw/` (PR open)
- Installable skills in `src/omniclaw/skills/` and `.agents/skills/`

## Local Setup

Expand Down
Loading