Skip to content

Latest commit

 

History

History
29 lines (22 loc) · 934 Bytes

CONTRIBUTING.md

File metadata and controls

29 lines (22 loc) · 934 Bytes

Contributing

Before you start

  • Use Node.js 18 or newer.
  • For a bug, open an issue with the version, Node version, and a minimal reproduction. For a security problem, follow SECURITY.md instead of opening a public issue.

Set up

npm ci
npm test

npm test runs the build check, the unit suite, and the frozen baseline. The live suite needs reachable SSH hosts; test/README.md documents the environment and the curated batch.

Pull requests

  • Branch from master. master requires a pull request, the CI matrix, and the live suite, so direct pushes are rejected.
  • Keep the change focused, and update README.md, docs/, and CHANGELOG.md when behaviour changes.
  • Use npm run test:live for connection, command-flow, and hop changes. Run npm run test:live:all before a release.
  • The release process is in docs/PUBLISHING.md.