Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
30 lines (20 loc) · 1.24 KB

CONTRIBUTING.md

File metadata and controls

30 lines (20 loc) · 1.24 KB
Raw

Contributing to OpenCode Muse Multi Auth

Bug reports, documentation improvements and focused pull requests are welcome.

Local setup

Install Node.js 22+, the official Muse Code CLI and Bun, then run:

npm ci
npm test
npm run test:tui
npm pack --dry-run

Use npm link to try muse-auth from another project directory. Set OPENCODE_MUSE_STATE_DIR to a temporary directory when testing account preferences. Keep real credentials, account profiles and diagnostic logs out of commits.

Making changes

  • Keep the CLI, JavaScript runtime and OpenCode integration consistent.
  • Preserve the requested model when switching accounts.
  • Add regression coverage for behavioural changes, especially authentication, stream handling and quota routing.
  • Use British English for user-facing text and documentation.
  • Describe the change and the checks you ran in your pull request.

Reporting a problem

Include your OS, Node.js version, Muse CLI version, package version and a small reproduction. muse-auth doctor provides useful diagnostics. Redact any personal data before posting.

Report credential-related vulnerabilities through GitHub's private vulnerability reporting.