Get involved
SirixDB is developed in the open. Whether you use the database, build tools around it, or want to understand its internals, there are several ways to help.
Join the conversation
Join Discord for quick questions and development chat: get help, share what you’re building, and discuss design ideas. Use the Discourse forum for longer discussions that others can return to. If you’re unsure where to start, ask on Discord.
Report bugs and request features
Open an issue in the SirixDB issue tracker. For a bug, include the SirixDB version or commit, Java version and operating system, storage backend and resource settings, and the smallest JSON or XML input that reproduces the problem. Add the JSONiq/XQuery query or API calls you ran, the expected and actual results, and the full error output or stack trace. For a feature request, describe the use case and the behavior you need.
Contribute code
Pull requests to sirixdb/sirix are welcome. Start with the contribution guide for setup, the module map, and the development workflow. Read the architecture documentation and the specification chapters for the area you want to change. The spec records intended behavior; check each requirement’s status and evidence before assuming it is implemented.
The project’s testing standard is spec first, mutation testing, and explorative testing: write behavior, invariants, and error cases, derive tests before implementation, mutation-test changed logic, and explore beyond the happy path. The contribution guide and verification guide explain the required evidence. Browse issues labeled good first issue for starting points. For larger changes, ask on Discord and discuss the proposal in an issue before starting work.
Help with tools and clients
You can also contribute to the tools around the database. Read each project’s README and existing issues before choosing a change:
- Python client and TypeScript client — client libraries in their own repositories.
- Kotlin API — the coroutine-based API in the main repository.
- MCP server — Model Context Protocol integration in the main repository.
Improve the documentation
This website lives in sirixdb/sirixdb.github.io.
Documentation pages are Markdown files under
docs/.
Fix unclear explanations, add reproducible examples, or document a workflow that
helped you. To add a page, use the documentation layout and add its link to the
sidebar in _layouts/documentation.html. The shared header and footer live in
_includes/. Follow the website README
to preview your changes and run the site’s checks before opening a pull request.