Contributing to Caseum

Thank you for investing your time in contributing to our project!

Any contributions you make are governed by our License.

Please follow our Code of Conduct to keep our community approachable and respectable.

You could read the open source contribution guide for general advice on how to contribute.

Since this is a small hobby project, your contribution may not be noticed for a while if we are busy elsewhere. Sorry!

Reporting a security problem

Please do not open a public issue for a security problem. Use the “Report a vulnerability” button on the Security tab instead; private vulnerability reporting is enabled on the repository.

The site

This site is built with Astro Starlight.

Tools are exact-pinned in .mise.toml; run mise install once, then install the git hooks (once per clone):

prek install -t pre-commit -t commit-msg

Then:

• mise run docs-install - Install the site dependencies (bun).
• mise run docs-dev - Start the live-reloading docs server.
• mise run docs-build - Build the documentation site into docs/dist.
• mise run docs-check - Run the Astro type and content check.
• mise run lint - Run the formatting, Markdown and secret-scanning hooks.
• mise run lint-links - Check external Markdown links (needs network). Not a pull-request check; it runs weekly instead, so that a third-party host being slow cannot block a merge.
• mise run ci - Run the same checks, in the same order, as CI. This includes the internal link check, which does gate pull requests.

Commit messages follow Conventional Commits (type(scope): description) and are checked by a commit-msg hook.

Quarto

The introduction presentation is built with Quarto.

Run mise run docs-presentation to render it. That task pins its own Quarto version, so you do not need Quarto installed or listed in .mise.toml [tools].

(The presentation is modified so rarely the outputs are checked into git.)