Skip to main content
Bach is open source under the MIT license, and bug reports, ideas, docs, translations and code are all welcome. This page is the short version; the full guide is CONTRIBUTING.md. Everyone follows the Code of Conduct.

Ways to help

Report a bug

A small bach.toml, the output of bach doctor and the setup log make it much faster to fix.

Suggest a feature

Start from what you are trying to do, not from the setting you would like.

Fix a translation

Every window text exists in 19 languages. A native speaker’s correction is worth a lot.

Send a pull request

Small and focused is easiest to review.

What Bach is about

These principles decide what fits:
  • Simple for the developer. One small config file with sensible defaults, no script language.
  • Calm for the end user. One window, few choices, honest progress, readable errors, light and dark mode, no administrator prompt unless the app asks for one.
  • Safe by construction. Packaged paths cannot leave the install folder, and the uninstaller removes only what it installed.
  • Updates just work, and setup files in the wild keep working.

Set up

You need Rust (stable) and, on Windows, the Visual Studio C++ build tools. bach builds on macOS and Linux too; the installer window (bach-setup) is Windows only.
Look at the window without installing anything:

Before you open a pull request

Both of these must pass, and CI runs them too:
  • Look at UI changes with --preview in light and dark, with a long app name and a long install path.
  • Real installs only through the example. scripts/e2e.ps1 installs, updates and removes a throwaway app. Do not run a real install of anything else to test a change.
  • Add tests next to the code. Changes to path rules, the work modules or launch need tests for the unsafe case too.
  • Update the docs when a setting, command or behaviour changes. See below.
  • Texts the window shows are bach_pack::i18n::Keys with a translation in every language, never a literal in the window code.
  • Use Bun for JavaScript, never npm, pnpm or yarn.

Keep these docs up to date

When you add or change a setting, command, flag, text, default or behaviour, update the matching page in these docs in the same piece of work, plus schema/bach.schema.json and skills/bach/SKILL.md if agents need to know. The project’s AGENTS.md asks coding agents to do the same.

Commits and pull requests

  • Make several small commits that each build and pass the tests.
  • Write the subject in the imperative and start with a verb: “Add…”, “Fix…”, “Improve…”. The release changelog is generated from these subjects.
  • Branch from main, open the pull request against main, fill in the template and say which checks you ran.
  • Never commit secrets, target/, dist/ or node_modules/.