Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
47 lines (33 loc) · 1.29 KB

CONTRIBUTING.md

File metadata and controls

47 lines (33 loc) · 1.29 KB
Raw

Contributing

Thanks for helping improve ZeroSyntax v2. The project uses maintainer-reviewed pull requests with CI as the merge gate.

Development setup

Install Rust 1.75 or newer, Node.js 20 or newer, and npm.

cargo test --locked
cargo fmt --all --check
cargo clippy --locked --all-targets --all-features -- -D warnings

cd editors/vscode
npm ci
npm test

The optional real-game corpus is not committed. Fetch it only when you need the ignored corpus test:

scripts/fetch-corpus.sh
cargo test --release -p zerosyntax-analysis --test corpus -- --ignored --nocapture

On Windows, use pwsh scripts/fetch-corpus.ps1.

Pull requests

  • Keep changes focused. Split unrelated fixes into separate PRs.
  • Add or update the smallest test that would catch the behavior you changed.
  • Run the commands above before requesting review.
  • Do not commit GeneralsCode/, corpus/, examples/, build outputs, extension packages, secrets, or local editor state.

Issue reports

For bugs, include a small INI sample, the expected behavior, the actual diagnostic or editor behavior, and your OS/editor version. For feature requests, describe the workflow the feature should improve.

Releases

Maintainers release from the dev and prod branches. See the release process.