Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (19 loc) · 769 Bytes

CONTRIBUTING.md

File metadata and controls

28 lines (19 loc) · 769 Bytes
Raw

Contributing

This project is developed test-first.

Workflow

  1. Write or update a Bats test for the behavior you want.
  2. Run the test and confirm it fails for the expected reason.
  3. Implement the smallest change that makes the test pass.
  4. Run the full test suite.
  5. Refactor only while tests are green.

Tests

Install bats-core, then run:

bats test

Tests must not read from or write to a real user home directory. Use temporary HOME, XDG_CONFIG_HOME, and PATH values.

Style

  • Keep the script zsh-only until multi-shell support is explicitly added.
  • Prefer small functions with stable, testable behavior.
  • Do not add machine-local config or secrets.
  • Do not overwrite existing user files without an explicit safety mechanism.