Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
56 lines (37 loc) · 1.66 KB

CONTRIBUTING.md

File metadata and controls

56 lines (37 loc) · 1.66 KB
Raw

Contributing

Thanks for your interest in improving prun-operator!

Prerequisites

  • Bun
  • Violentmonkey (recommended over Tampermonkey — it auto-reloads the userscript when the dev server rebuilds)

Setup

bun install
bun dev

bun dev starts Vite with vite-plugin-monkey. On first run, open the printed URL to install the dev userscript into Violentmonkey. After that, edits to src/ rebuild automatically and the script reloads in the browser on your next navigation/refresh of https://apex.prosperousuniverse.com/.

Project layout

src/
  main.ts       # entry — wires up the MutationObserver
  tiles/        # per-tile enhancements (one module per tile type)
  components/   # Preact UI used inside injected tiles
  tools/        # cross-tile features (e.g. copy sell contract)
  utils/        # DOM helpers, React-safe input simulation, etc.

See CLAUDE.md for architecture notes — tile matching, React-controlled input simulation, and CSS class substring selectors.

Build

bun run build

Outputs the userscript to dist/prun-operator.user.js.

Code style

Biome handles formatting and linting:

bunx biome check --write .

Pull requests

  • Keep PRs focused — one feature or fix per PR.
  • Run bunx biome check --write . and bun run build before submitting.
  • If you're adding support for a new tile type, follow the pattern in src/tiles/ and register the handler in src/tiles/index.ts.

License

By contributing, you agree that your contributions will be licensed under the Apache License 2.0.