Code, documentation, translations and bug reports are welcome.
Before you startedit
- If the change is large or open to discussion, open an issue first.
- Work on your own branch created from
develop. - Make small and descriptive commits.
- Update the documentation if the project rules change.
Reporting an issueedit
Open an issue with:
- A clear description of the problem.
- Steps to reproduce.
- CubicLauncher and operating system version.
- A log link on mclo.gs if applicable.
Commitsedit
The format is:
text
<type>(<optional scope>): <short description>
[optional body]
[breaking change / issue reference]Common types: feat, fix, refactor, perf, style, docs, test, chore, i18n, and core for the Rust backend.
- Messages are in Spanish, in infinitive or imperative form.
- The first line must not exceed 72 characters.
- Describe the what, not the how.
- One commit per logical change.
- Mark breaking changes with
!or withBREAKING CHANGE:in the body.
Pull request workflowedit
- Create a branch from
develop. - Implement the change and update the tests.
- Run the local checks:bash
bun run lint bun run check bun run test:all cargo fmt --all --check cargo clippy --workspace -- -D warnings - Open the PR against
developand assign at least one label. - Reply to review with new commits on the same branch; avoid rewriting history unless asked.
PR labelsedit
| Label | Use |
|---|---|
breaking | Change that breaks compatibility. |
feature | New user-visible feature. |
core | Rust backend. |
ui | Visual changes in Svelte or CSS. |
i18n | Translations or language files. |
bug / fix / patch | Fixes. |
perf | Performance. |
test | Tests. |
docs | Documentation. |
chore / refactor / deps / ci | Maintenance. |
ignore-for-release | Must not appear in the changelog. |
Code conventionsedit
- Rust:
rustfmtand Clippy with no warnings. Errors are serialized as{"code":"...","params":{...}}for i18n. - Svelte/TypeScript: Svelte 5 runes, no
any,keyin{#each}blocks and$derivedfor computed values. - CI: formatting, lints and tests run on GitHub Actions; a PR does not move to full review until everything is green.
Translationsedit
Translations are maintained in CubicLauncherDevs/Translations. The launcher bundles es-ES and en-US as local fallbacks.
To add a new key:
- Add it in
src/lib/i18n/en-US.jsonandsrc/lib/i18n/es-ES.json. - In the translations repo, edit
src/locales/*.json. - Increase the
versionfield of each modified language. - Add the entry in
src/changelog.json. - Run
bun run build && bun run deployin the Worker.
To fill missing keys compared to en-US, use bun run sync-locales in the translations repository.