Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
68 lines (45 loc) · 1.86 KB

CONTRIBUTING.md

File metadata and controls

68 lines (45 loc) · 1.86 KB
Raw

Contributing

Thanks for your interest in improving Chutes Usage Monitor.

Prerequisites

  • Node.js 22.17.0 (the exact version in .nvmrc)
  • npm
  • Visual Studio Code

Development Setup

  1. Install the locked dependencies:
npm ci
  1. Build the extension:
npm run compile
  1. Run the test suite:
npm test
  1. Run the complete preflight before opening a pull request:
npm run preflight

Use npm install only when intentionally changing dependencies so that package-lock.json is updated together with package.json.

Running The Extension Locally

  1. Open the repository in VS Code.
  2. Run npm ci if dependencies are not installed yet.
  3. Press F5 to launch an Extension Development Host window.
  4. In the new window, run Chutes Usage Monitor: Set API Key to test the extension manually.

If you are editing both extension-host code and webview assets, run npm run compile again before reloading the Extension Development Host.

Contribution Guidelines

  • Keep changes focused and minimal.
  • Prefer small fixes over broad refactors.
  • Add or update tests for parser and state behavior changes.
  • Preserve user privacy. Do not log API keys or sensitive account data.
  • Use npm so local development matches the checked-in lockfile and CI workflow.
  • Update documentation when user-facing behavior changes.

Pull Requests

Before opening a pull request:

  1. Run npm run preflight to compile, test, audit dependencies, and build the VSIX.
  2. Update CHANGELOG.md when the change is user-visible.
  3. Update README.md or files in docs/ when setup, behavior, or support guidance changes.

Reporting API Shape Issues

If Chutes changes the shape of an endpoint response, include a redacted sample payload in the issue when possible. Remove secrets and personal data, but keep field names and numeric values intact.