Contributing

Thank you for considering contributing to Apollon. The full contributor guide lives in the docs site:

→ Contributor Guide (or docs/contributor/ in the repo)

In short:

git clone git@github.com:ls1intum/Apollon.git
cd Apollon
nvm install && nvm use
pnpm install
pnpm dev

Before pushing:

pnpm run lint
pnpm run format:check
pnpm run build
pnpm test

Commits follow Conventional Commits with a constrained type and scope set — see commitlint.config.mjs. The repository is squash-merge only, so your PR title is the merge commit subject and is checked against the same rules. The title's type also groups the release note (full mapping: How your change gets grouped), so pick it for the user-visible kind of change.

On any PR that changes a Changesets-tracked package — @tumaet/apollon, @tumaet/webapp, or @tumaet/server — add a changeset:

pnpm changeset

It becomes the changelog entry — writing rules are in the release-notes guide. Skip it on docs-, CI-, or refactor-only PRs, and on the VS Code extension (it has a separate release flow and is excluded in .changeset/config.json).

AI coding agents (Claude Code, Cursor, Copilot, Codex, …) follow AGENTS.md.

By participating in this project you agree to abide by its Code of Conduct.