Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
53 lines (39 loc) · 1.64 KB

CONTRIBUTING.md

File metadata and controls

53 lines (39 loc) · 1.64 KB
Raw

Contributing

Thanks for helping improve PlatformIO workflows in Zed.

Project rules

  • Keep the project open source and editor-agnostic where possible.
  • No .env-driven configuration model.
  • No private machine config, hidden automation scaffolding, or personal files in the published repo.
  • Prefer small, readable Rust over clever abstractions.
  • Every integration decision should map back to documented Zed or PlatformIO behavior.
  • If Zed does not support something today, document the limitation instead of faking parity with VS Code.
  • Keep the project clearly marked as unofficial and not affiliated with PlatformIO Labs or Zed Industries.

Development principles

  • Minimize magic.
  • Prefer transparent pio command generation over wrappers that hide behavior.
  • Keep PlatformIO parsing and task generation independently testable.
  • Avoid unnecessary dependencies.

Local setup

cargo test
cargo fmt

To test against a PlatformIO project:

cargo run --bin platformio-for-zed -- --project-dir /path/to/project --backup --with-clangd

Pull request checklist

  • Tests pass with cargo test
  • Code is formatted with cargo fmt
  • README/docs are updated when behavior changes
  • No generated binaries, logs, personal paths, .env files, or machine-local config are committed
  • Zed and PlatformIO limitations are documented honestly
  • New UX claims are backed by Zed API docs or working code

Reporting bugs

Please include:

  • Zed version
  • PlatformIO Core version (pio --version)
  • operating system
  • relevant platformio.ini
  • generated .zed/tasks.json if applicable
  • exact command and output