Contributing
Contributions are welcome: bug reports, documentation fixes, tests and code.
Reporting Issues
Section titled “Reporting Issues”Open an issue with:
- What you ran, including the exact command or code.
- What you expected and what happened, with logs (
-vhelps). - Your platform, compiler and Detent commit.
Report security issues privately through GitHub security advisories.
Building and Testing
Section titled “Building and Testing”cmake -B build -DCMAKE_BUILD_TYPE=Releasecmake --build build -jctest --test-dir build --output-on-failureExpectations for Changes
Section titled “Expectations for Changes”- Tests with the change. New behavior comes with tests; bug fixes come with a regression test that fails before the fix.
- Sanitizers. Concurrency and memory changes should pass ASan/UBSan and TSan.
- Measurements, not adjectives. A performance claim needs a reproducible benchmark, its before and after numbers, and its caveats.
- Bounded everything. New inputs, queues and caches need explicit limits checked before allocation.
- Keep the read path clean. Nothing that allocates, locks or does I/O
goes on
eval/get. - Document as you go. Update the design documents in
docs/and this website alongside the code.
This Website
Section titled “This Website”The site lives in website/ and is built with
Astro and Starlight,
using the same theme as the Xapiand documentation:
cd websitenpm cinpm run dev # http://localhost:4321/Detentnpm run build # static site in website/dist, with Pagefind searchDiagrams are ```d2 fences rendered at build time, so install
D2 to preview them. Every page has an Edit page link.
Pushing to main deploys the site to GitHub Pages.