starred/warmbly
1
0
Fork 0
mirror of https://github.com/warmbly/warmbly.git synced 2026-08-19 16:01:16 +00:00
Code Issues Packages Projects Releases Wiki Activity
Files
73d8ea3b5e7f47a457007ebdd856495e21bcc438
warmbly/CONTRIBUTING.md
T
Matthew Meszaros fe6b2cca54 feat: update repository docs branding 
Replace the repository logo with the site mark on a sky background and move contribution guidance into CONTRIBUTING.md.
2026-05-31 08:57:26 +02:00

881 B
Raw Blame History

Contributing

Bug reports and pull requests are welcome. Keep changes scoped to one logical change and open an issue first for larger design or product changes.

Before opening a pull request, run the checks for the part of the repo you touched:

  • Go: make fmt and make lint
  • Dashboard/admin/site: pnpm typecheck and pnpm lint in the affected tree
  • Rust tracking service: cargo fmt and cargo test
  • Realtime service: mix format and mix test

When changing backend or worker behavior, keep the control-plane and execution-plane split intact. Workers should not connect directly to Postgres; route stateful workflows through the backend or event bus instead.

When adding an external dependency, keep self-hostability intact. Any required third-party service needs an open-source or self-hosted path documented in docs/VENDOR_LOCKIN.md.

Reference in New Issue View Git Blame Copy Permalink