Skip to content

Contributing

new-usemame edited this page Jul 4, 2026 · 2 revisions

Contributing

  • Bug reports: open a bug issue. Reproduction steps, version tag, and a docker logs snippet help a lot.
  • Feature requests: open a feature issue. The bar is low — bug reports get prioritized for code work, but feature requests shape what gets looked at when the bug queue is quiet, and they help upstream see what users actually want. Don't worry about whether it's "in scope"; just file it.
  • Pull requests: welcome. The merge bar is "doesn't break anything that currently works." Changes touching auth, schema, or dependencies get a closer review. Backports keep the original author's handle in the commit message.
  • CWA PR authors with stalled work upstream: if you'd like your PR shipped here too, open an issue or send the PR our way.

Governance: GOVERNANCE.md. Contributing details: CONTRIBUTING.md.


Translations

The interface ships with a wide set of locales. Completion is auto-refreshed on every push to main, so the live status table (with per-language completion percentages) lives in the README rather than here, where it would drift.

To contribute a translation, edit the .po file under cps/translations/ for your language and open a PR.


Credits

Built on:

  • Calibre-Web-Automated (@crocodilestick and contributors) — the core software this build is based on. Original PR authors are credited by handle in every backport commit.
  • Calibre-Web (@janeczku and contributors) — the web UI underneath CWA.
  • Calibre (@kovidgoyal) — the library underneath all of it.

Every backported patch is credited to its original author by GitHub handle in the commit message and in CHANGES-vs-upstream.md.

If this build is useful to you, you can support its development on Ko-fi. To support the upstream project it builds on, @crocodilestick has a Ko-fi too.

Clone this wiki locally