Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
65 lines (51 loc) · 3.05 KB

CONTRIBUTING.md

File metadata and controls

65 lines (51 loc) · 3.05 KB
Raw

Contributing

Thanks for your interest. This is a single-maintainer project, so a note on how it works before you spend time on anything.

Reporting things

  • Bugs and feature requests: open an issue. The templates ask for the things that usually decide whether a bug is reproducible.
  • Security issues: do not open a public issue. See SECURITY.md -- crafted-file crashes, redaction that leaves content behind, and signature verification that trusts the wrong thing all belong there.
  • A good bug report beats a speculative pull request. The most valuable thing you can attach is a document that reproduces the problem.

Pull requests

Please open an issue first for anything beyond a typo or an obvious small fix. The project has a specific bar (below) and a fairly opinionated architecture, so a PR that arrives without discussion may need rework that would have been cheaper to talk about first.

If you do send one:

  • Match the surrounding code. Comments here explain why a thing is the way it is -- particularly where something non-obvious was learned the hard way.
  • Include tests. tests/ is vitest (renderer) and pytest (engine); e2e-tests/ drives the built binary with WebdriverIO.
  • Run the gates: npx tsc --noEmit, npm run lint, npm test, npm run build:renderer, and cargo check in src-tauri if you touched Rust. For engine changes, run pytest.

The bar

A feature ships when it is complete and correct, or it doesn't ship. There are no partial releases, no feature flags hiding half-built work, and no "we'll finish it next version". If a capability is present in the product, it is expected to work fully -- so a PR that adds a surface without the behaviour behind it will be asked for the rest, and a PR that adds a refusal with a clear message is often preferred over one that half-does something silently.

The counterpart: honest refusals are fine. If the app can't do something with a given file, saying so plainly is a correct outcome. Producing quietly wrong output is not.

Building

See the README's Quick Start and Build sections. npm run prepackage vendors every runtime the app needs — embedded Python, the ICC colour profiles, the edit fonts, LibreOffice, native Tesseract, and the OCR language models — and every one of them is required for a build to succeed. Ghostscript is NOT among them: it is not shipped with the product. Install one on your machine if you want to work on, or test, the features that need it. npm run package:unsigned is the local build: prepackage plus the Rust compile and the NSIS installer. (npm run package without :unsigned is the release shape — it also signs the updater artifacts, which needs TAURI_SIGNING_PRIVATE_KEY, a key that lives only in the release workflow's secrets.)

Licensing

The project is MIT. By contributing you agree your contribution is licensed the same way. Third-party components are vendored at arm's length and documented in THIRD-PARTY-LICENSES.md -- if a change adds or updates one, that file is part of the change.