Contributing

LeiOS is open source, and contributions of every size are welcome: bug reports, documentation fixes, packages, and code.

Repositories

All LeiOS projects are developed on git.leicraftmc.de/LeiOS and mirrored to GitHub.

Repository	What it is
live-images	The live-build configuration for the LeiOS ISO and installer.
repo/api-server	The Repository API: package uploads, checks, and publishing.
Hub-Website	The Developer Hub at hub.leios.dev.
website	This website and its documentation.

Bun as runtime, package manager and test runner.
TypeScript everywhere, formatted and linted with Biome.
Nuxt 4, Nuxt UI and Tailwind CSS for the web projects.
Conventional Commits for commit messages: feat:, fix:, docs:, chore:, and so on.
AGPL-3.0 as the license.

Read the style guide before your first larger contribution. Small fixes are welcome any time.

Every docs page has an Edit this page link at the bottom that opens the page's source on git.leicraftmc.de. To work on the docs locally:

git clone https://git.leicraftmc.de/LeiOS/website.git
cd website
bun install
bun run dev

The dev server runs on http://localhost:12155.

Pages are Markdown files in content/docs/. Each needs title, description and navigation.title frontmatter.
The sidebar and the previous/next links come from app/data/docs.ts. Add new pages there, and to public/static/utils/sitemap.xml.
Before you open a merge request, run the checks:

bun run check
bun run typecheck
bun test
bun run generate

Want to ship software to LeiOS users? See Publishing Packages.