Developer Guides

This section is intended for SDK maintainers and contributors who work on the Synapse SDK codebase itself.

Who is this for?

• SDK Maintainers: Developers who maintain and extend the SDK
• Contributors: Anyone who wants to contribute to the project
• Plugin Developers (Advanced): Those who need to understand internal APIs

If you're looking to use the SDK to build plugins, see the Plugin System guide instead.

What's in this section

Contributing

Learn how to set up your development environment, follow code quality standards, write tests, and submit pull requests.

• Development Setup - Set up your local environment
• Code Quality - Ruff, pre-commit hooks, and style guidelines
• Testing - Write and run tests
• Pull Requests - PR process and review guidelines
• CI/CD - GitHub Actions and release process

Architecture

Understand the internal design and structure of the SDK.

• Project Structure - Codebase organization

API Reference

Detailed API documentation auto-generated from source code.

• Clients Reference - HTTP client internals
• Plugins Reference - Plugin system internals
• Utilities Reference - Utility modules
• CLI Reference - CLI implementation