Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
26 lines (15 loc) · 1.05 KB

CONTRIBUTING.md

File metadata and controls

26 lines (15 loc) · 1.05 KB
Raw

Contributing to OrcaSync

Thanks for your interest. The short version:

Reporting bugs

Open an issue with steps to reproduce, the OrcaSync version (Settings screen), your OS, and the OrcaSlicer version you're syncing against. Logs from View → Toggle DevTools → Console help if the UI is misbehaving.

Suggesting changes

Open an issue first if it's a non-trivial change — an architecture tweak, a new provider, or a UX shift — so we can agree on direction before you spend time. Small fixes can go straight to a PR.

Pull requests

  • Run cargo fmt --all and cargo clippy --workspace --all-targets -- -D warnings before pushing.
  • Run npm --prefix frontend run typecheck for frontend changes.
  • One logical change per PR. Avoid drive-by refactors in feature PRs.
  • New providers go in crates/provider-<name>/ and implement orcasync_providers::SyncProvider.

Local dev

See README.md → Development.

License

By contributing you agree your work is dual-licensed under MIT or Apache-2.0, matching the project.