Contributing
Thank you for your interest in contributing to sqltgen.
The full contributing guide — build instructions, test suite, code style, and step-by-step walkthroughs for adding new backends and dialects — is in CONTRIBUTING.md in the repository root.
The detailed technical reference — architecture overview, IR data model, and guides for adding new backends, dialects, and examples — is in docs/contributor-guide.md.
Quick reference
# Clone and build
git clone https://github.com/sqltgen/sqltgen.git
cd sqltgen
cargo build
# Run all tests
cargo test
# Format and lint
cargo fmt
cargo clippy -- -D warnings
Opening a pull request
- Fork the repository and create a feature branch.
- Make your changes; run
cargo fmtandcargo clippy. - Add or update tests to cover the change.
- Open a PR with a clear description of what changes and why.
Keep PRs focused — one logical change per PR makes review much easier.
Questions?
Open an issue or start a discussion on the GitHub repository.