Skip to content

Contributing

Contributions are welcome: bug reports, documentation fixes, tests and code.


Open an issue with:

  1. What you ran, including the exact command or code.
  2. What you expected and what happened, with logs (-v helps).
  3. Your platform, compiler and Detent commit.

Report security issues privately through GitHub security advisories.


Terminal window
cmake -B build -DCMAKE_BUILD_TYPE=Release
cmake --build build -j
ctest --test-dir build --output-on-failure

  1. Tests with the change. New behavior comes with tests; bug fixes come with a regression test that fails before the fix.
  2. Sanitizers. Concurrency and memory changes should pass ASan/UBSan and TSan.
  3. Measurements, not adjectives. A performance claim needs a reproducible benchmark, its before and after numbers, and its caveats.
  4. Bounded everything. New inputs, queues and caches need explicit limits checked before allocation.
  5. Keep the read path clean. Nothing that allocates, locks or does I/O goes on eval/get.
  6. Document as you go. Update the design documents in docs/ and this website alongside the code.

The site lives in website/ and is built with Astro and Starlight, using the same theme as the Xapiand documentation:

Terminal window
cd website
npm ci
npm run dev # http://localhost:4321/Detent
npm run build # static site in website/dist, with Pagefind search

Diagrams 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.