harivansh-afk/deskctl
1
1
Fork 0
mirror of https://github.com/harivansh-afk/deskctl.git synced 2026-04-15 04:03:28 +00:00
Code Issues Projects Releases Packages Wiki Activity Actions
deskctl/CONTRIBUTING.md
Hari 714e34ba19
nix (#7) 
npm
cargo
2026-03-25 23:18:28 -04:00

2.3 KiB
Raw Blame History

Contributing

Prerequisites

  • Rust toolchain
  • make
  • pre-commit for commit-time hooks
  • pnpm for site formatting checks
  • Linux with xvfb-run for integration tests

Install site dependencies before running site checks:

pnpm --dir site install

Repository Layout

  • src/lib.rs exposes the library target used by integration tests
  • src/main.rs is the thin CLI binary wrapper
  • src/ holds production code and unit tests
  • tests/ holds integration tests
  • tests/support/ holds shared X11 and daemon helpers for integration coverage
  • docs/runtime-output.md is the stable-vs-best-effort runtime output contract for agent-facing CLI work

Keep integration-only helpers out of src/.

Local Validation

The repo uses one local validation surface through make:

make fmt-check
make lint
make test-unit
make test-integration
make site-format-check
make cargo-publish-dry-run
make npm-package-check
make nix-flake-check
make dist-validate
make validate

make validate runs the full Phase 2 validation stack. It requires Linux, xvfb-run, and site dependencies to be installed. make dist-validate runs the distribution validation stack. It requires npm, nix, and Linux for the full npm runtime smoke path.

Pre-commit Hooks

Install the hook workflow once:

pre-commit install

Run hooks across the repo on demand:

pre-commit run --all-files

The hook config intentionally stays small:

  • Rust files use default rustfmt
  • Site files reuse the existing site/ Prettier setup
  • Slower checks stay in CI or make validate

Distribution Work

Distribution support currently ships through:

  • crate: deskctl
  • npm package: deskctl-cli
  • repo flake: flake.nix
  • command name on every channel: deskctl

For maintainer release and publish steps, see docs/releasing.md.

Source-build and packaging work should keep Docker as a local Linux build convenience, not as the canonical registry release path.

Integration Tests

Integration coverage is Linux/X11-only in this phase. The supported local entrypoint is:

make test-integration

That command runs the top-level X11 integration tests under xvfb-run with one test thread so the shared display/session environment stays deterministic.