Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
94 lines (73 loc) · 3.76 KB

CONTRIBUTING.md

File metadata and controls

94 lines (73 loc) · 3.76 KB
Raw

Contributing

Thanks for your interest in improving Super CLI.

Prerequisites

  • Node.js 22 (the repository includes .nvmrc)
  • npm (included with Node.js)
  • VS Code 1.93 or newer for Extension Development Host testing

Getting started

  1. Fork the repository and clone your fork locally.

  2. Install the locked dependency tree:

    npm ci

  3. Create a focused branch from an up-to-date main:

    git switch main
git pull --ff-only
git switch -c fix/agent-detection-wsl

  4. Make your changes, then run the same verification used by CI:

    npm run check

  5. Commit with a clear message, push to your fork, and open a Pull Request against main. Fill in the PR template completely.

Before opening an issue

  • Search existing issues — your problem may already be reported.
  • Use the Bug report or Feature request template.
  • For questions ("how do I...?", "does it work with...?"), open a Discussion instead of an issue.
  • Report vulnerabilities privately according to SECURITY.md.

Code style

  • TypeScript strict mode — no any unless justified.
  • Follow the existing patterns in src/; consistency matters more than personal preference.
  • Keep user-facing behavior documented in README.md.
  • Keep external installation links on credential-free HTTPS URLs. Super CLI opens documentation but never accepts installer commands.
  • Keep credentials out of commands, settings, fixtures, and .env files. Use each CLI's supported credential store or local shell environment.
  • Third-party marks must come from an authoritative public source, remain limited to product identification, and be recorded in media/agents/ATTRIBUTION.md and TRADEMARKS.md.
  • Package only static, safe SVGs without scripts, embedded images, or external references. See docs/BRAND.md before changing Super CLI's own logo or interface marks.

Pull requests

  • Link the related issue (Fixes #123) when applicable.
  • Add or update tests for launcher behavior, agent presets, and package metadata.
  • Include screenshots or a short recording for any UI-visible change.
  • Run npm run check before submitting.
  • Keep PRs focused — one concern per PR is easier to review and merge.
  • Do not commit generated out/, .vsix, .vscode-test/, or node_modules/ content.

Dependency and supply-chain changes

  • Keep dependency changes in devDependencies; Super CLI has zero runtime dependencies.
  • @types/vscode must remain aligned with engines.vscode and is intentionally ignored by Dependabot. Raise both together only when the extension actually needs a newer VS Code API.
  • npm install scripts are approved by exact package version in package.json#allowScripts. If an install reports a new pending script, inspect the package and script before approving it; do not replace the version-pinned entries with an open-ended package-name approval.
  • GitHub Actions must use immutable 40-character commit SHAs. Dependabot keeps both npm dependencies and action references current on a weekly schedule.

Release checklist (maintainers)

  1. Choose the next semantic version and update package.json, package-lock.json, CHANGELOG.md, and CITATION.cff together.
  2. Run npm ci, npm run audit, and npm run check.
  3. Run npm run package and inspect the file list reported by vsce.
  4. Install the generated VSIX in a clean Extension Development Host and verify the sidebar, launcher, settings, toolbar icon, and one terminal launch.
  5. Commit and push the reviewed files, then create the matching v<version> tag and publish the same VSIX to the intended registries.