SynapSynapDocs

Contributing

The open-source Synap repositories, how to start contributing to each, and where to ask questions.

For ContributorsOpen-source podCLIReviewed 2026-10-20

Synap's pod and its command-line tool are open source under the MIT license, and this documentation is a public repository. Contributions are welcome in each of them.

The repositories

RepositoryWhat it isStart with
Synap-core/backendThe pod: API, database schema, workers, MCP server, deploy tooling and the agent skills (skills/)The repository's README and contributing guide
Synap-core/synap-cli@synap-core/cli, the user CLI that connects computers and agents to a podThe repository's README and contributing guide
Synap-core/docThis siteDocs style guide

Each repository's own contributing guide is the source of truth for how to build, test and submit changes there. Read it before opening a pull request: the pod repository in particular has architecture rules and checks that a pull request must pass.

The SDK packages (@synap-core/sdk, @synap-core/react) are published on npm under the MIT license; their source repository is not public yet.

Ways to contribute

  • Report a bug in the repository it belongs to, with the version (synap status --json for a pod, synap --version for the CLI) and the steps to reproduce it.
  • Fix the docs. Every page is a file under content/docs/ in Synap-core/doc. See the docs style guide.
  • Improve a skill. The agent skills live in skills/ in the backend repository. See Agent skills.
  • Report a vulnerability privately, never in a public issue: see Security.

Talk to us

Everyone taking part follows the code of conduct.

On this page