KOMA Studio logo
KOMAStudio
Contributing

Contribute to KOMA Studio

Fix a bug, translate the interface, document a workflow, or send a reproducible report. Every contribution moves the project forward, and none of them require being a maintainer.

KOMA Studio is built in the open by people who use it to ship chapters. Code is only one of the ways to help — and it is rarely the most urgent one.

In Short

How do I contribute to KOMA Studio?

Start from an issue: report a bug, claim a good first issue, translate the UI, or improve the docs. Code contributions follow the usual fork, branch, commit, pull request flow.

  • Good first issues are labelled on GitHub
  • Non-code contributions matter just as much
  • Big changes are discussed before they are written

Before you start

Search the issue tracker first — someone may already be working on it. For anything larger than a bug fix, open an issue or a discussion and describe the approach before writing code. Small, focused pull requests get reviewed fastest.

  • Search existing issues and pull requests
  • Discuss large changes before implementing them
  • One concern per pull request

Development workflow

Fork the repository, create a branch, make the change, and open a pull request against the default branch. Include what changed, why, and how you tested it — screenshots or sample pages help a lot for visual work.

  • gh repo fork, then git switch -c your-change
  • Conventional commit messages (fix:, feat:, docs:)
  • Run the linter and build before pushing
  • Describe the change and attach screenshots

Ways to help that are not code

A project like this lives or dies on real-world feedback. Translations, documentation, and reproducible bug reports from actual chapters are often more valuable than another feature branch.

  • Translate the UI and the documentation
  • Report bugs with a sample page and exact steps
  • Test builds on your operating system
  • Answer questions in the community Discord

What to expect in review

Reviews are public and focused on the code, not the person. Expect questions about edge cases, performance on large chapters, and whether the change fits the workflow. Maintainers may ask for changes before merging — that is normal for any open-source project.