Community
Community
How to ask questions, report bugs without sharing private drawings, contribute under the clean-room rules, and how cadkit is governed.
Questions and ideas
Ask in GitHub Discussions: how to read a particular file, which API fits a task, or an idea for a new feature. Start with the documentation and the Rust API reference on docs.rs.
Bug reports
Open an issue with the cadkit version, the interface you used (Rust, Python, JavaScript, C or the CLI), what you expected and what happened, and a minimal file that shows the problem.
Security vulnerabilities are never reported in a public issue; see Security.
Contribute
Pull requests are welcome. Read CONTRIBUTING.md, AGENTS.md and docs/ARCHITECTURE.md first; they bind human and automated contributors alike. In short:
- Clean-room. Format knowledge comes only from allowed references (the public Open Design Specification for DWG, the MIT-licensed ACadSharp, ezdgn and GDAL DGN driver, public samples and your own analysis). Code from copyleft-licensed CAD projects, vendor SDKs and anything decompiled is off limits; if you have read such code, say so before contributing in that area.
- Provenance. Every source you rely on gets a row in docs/PROVENANCE.md, and ported logic is attributed.
- No panics on any input. Sizes and counts from a file are checked against the reader limits before allocating; recoverable problems become warnings.
- Tests with synthetic fixtures that document the byte layout; update the docs and the Unreleased section of the changelog.
- Code, comments and documentation are in English.
Code of conduct
Everyone taking part follows the Code of Conduct, adapted from the Contributor Covenant 2.1. Report unacceptable behaviour to conduct@cadkit.org; reports are handled in confidence.
Governance
cadkit currently has one maintainer, the GitHub account TNYCL, who reviews and merges pull requests, sets the roadmap and format scope, cuts releases and handles security reports. Day-to-day changes are decided in pull requests; larger ones (a new format, a new binding, a change to the document model or a breaking API change) start as an issue or a discussion. Contributors who land several substantial, well-tested changes and review others' work can be invited to become maintainers. The full text is in GOVERNANCE.md; contact the maintainers at maintainers@cadkit.org.
Support
cadkit is maintained by volunteers and offers no service-level guarantee. For anything that is not a question, a bug or a vulnerability, write to hello@cadkit.org. See SUPPORT.md.
Used by
- Cady, an architectural CAD application, uses
cadkit-geom,cadkit-sceneandcadkit-gpu.
An adopter is not a sponsor: cadkit stays vendor-neutral, and product-specific rules, customer data and domain logic of any adopter live outside the repository. Using cadkit? Say so in Discussions.
Cite or announce
Saying that your software uses, supports or is built with cadkit is welcome without asking, as is linking to the project with the name or the unmodified logo (logo files, name and logo policy). To cite cadkit in writing, name the version you used:
cadkit contributors. cadkit: an open CAD engine in pure Rust. Version 0.5.3. https://cadkit.org/ (source: https://github.com/TNYCL/cadkit).