Skip to content

Contributing

swayerloren edited this page Apr 13, 2026 · 1 revision

Contributing

Outside contributions are welcome, especially when they improve real behavior on real estimate documents.

This wiki page is only the short contributor orientation. The main repo docs are the source of truth for contributor workflow and subsystem details.

Read These First

  1. Main README
  2. Root CONTRIBUTING guide
  3. Developer docs start page
  4. Contributor docs section

Best Starting Points By Area

If you want to improve... Start here
parsing and layout support How to add new parsers
ESX output and mapping How to improve ESX output
UI behavior UI architecture
packaging and Windows releases Windows EXE build
docs and project structure Codebase tour

What Helps Most Right Now

  • new real-world PDF layout coverage
  • better guide-page and summary-page filtering
  • stronger line-item extraction on scan-heavy packets
  • better ESX compatibility evidence and mapping refinement
  • more regression tests around tricky estimate shapes
  • clearer user-facing troubleshooting and validation messages

What Not To Break

  • the canonical model boundary between parsing and export
  • deterministic export behavior
  • local-first execution
  • honest documentation about current limitations

Report The Right Kind Of Issue

  • parser/layout gaps: use the parser support issue template
  • output/import problems: use the ESX output issue template
  • general bugs: use the normal bug template
  • security issues: follow the private path in SECURITY.md

Open The Right Docs Next

Clone this wiki locally