We welcome contributions, feedback, and bug reports. This guide ensures you get the best support and helps us maintain a high-quality codebase.
Reporting Issues¶
If you encounter a bug or have a feature request, please search the GitHub Issues first. If it’s a new issue, use the template below to provide necessary context.
Issue Report Template¶
### Describe the bug
A clear and concise description of what the bug is.
### Steps to Reproduce
1. Run command '...'
2. Send payload '...'
3. See error '...'
### Expected Behavior
What was supposed to happen?
### Environment Details
- **Kroki-rs Version**: (Run `kroki-rs --version`)
- **Deployment Mode**: (CLI / Docker / Server)
- **OS**: (e.g. Ubuntu 22.04, macOS Sequoia)
- **Diagram Type**: (e.g. Mermaid, D2, Graphviz)
### Debug Logs
Please provide verbose logs by setting `RUST_LOG=debug`:
1. Restart the service: `RUST_LOG=debug kroki-rs serve`
2. Trigger the error.
3. Paste the relevant log output here.Getting Help¶
Discussions: Use GitHub Discussions for general questions, architectural ideas, and sharing your Kroki-rs integrations.
Documentation: Always check the Troubleshooting Guide for common pitfalls.
Contribution¶
Interested in writing code? Check out our Contributing Guide in the Developer Guide section.