Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
60 lines (40 loc) · 1.57 KB

CONTRIBUTING.md

File metadata and controls

60 lines (40 loc) · 1.57 KB
Raw

Contributing

Thanks for your interest in improving Chutes Usage Monitor.

Prerequisites

  • Node.js 22 or newer
  • npm
  • Visual Studio Code

Development Setup

  1. Install dependencies:
npm install
  1. Build the extension:
npm run compile
  1. Run the test suite:
npm test

Running The Extension Locally

  1. Open the repository in VS Code.
  2. Run npm install 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 test.
  2. Run npm run package.
  3. Update CHANGELOG.md when the change is user-visible.
  4. 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.