Skip to content

Ways to help

Open a bug report from the issues page. Blank issues are off, so the bug template is the only way in. It asks for:

  • What happened and what you expected. Rough notes are fine.
  • Maki version, shown in the sidebar footer.
  • How it is installed: Docker, Windows installer, Linux tarball, bare install, built from source, or not sure.
  • Anything else: steps to reproduce, screenshots, logs.

Steps to reproduce matter most. List what you did in order, starting from a state anyone can reach, such as a fresh library with one series.

Logs are in /config/logs in Docker and %LOCALAPPDATA%\Maki\logs for the Windows app. Paste the [ERR] or [WRN] lines from around the time of the problem, with a little context.

Do not report security problems in a public issue. Use the private security advisory form instead.

Use the feature request template. Describe what you do today and why it gets in the way. A well-described problem is more useful than a finished design.

For a new site, use the New source request template. Only the site URL is required. Add the languages, whether it sits behind Cloudflare, and whether it has a public API if you know.

Use GitHub Discussions for setup help, ideas and anything that might not be a bug.

No code needed. See Translating Maki for Weblate and the PO files.

Start with Development to get a build running, then the Architecture tour, and Pull request conventions before you open a pull request.