Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
39 lines (28 loc) · 1.03 KB

CONTRIBUTING.md

File metadata and controls

39 lines (28 loc) · 1.03 KB
Raw

Contributing to Task Cost Estimator

Thanks for helping improve tce.

Good First Contributions

  • Add or update model pricing in data/pricing.json.
  • Improve README examples.
  • Add tests for pricing, formatting, calibration, or history behavior.
  • Add provider documentation.
  • Report real-world estimate errors with private details removed.

Development

git clone https://github.com/359392475-blue-sky/task-cost-estimator.git
cd task-cost-estimator
npm install
npm test

Try the CLI locally:

node bin/tce.js models
node bin/tce.js help

Pull Requests

  1. Keep each pull request focused.
  2. Include the reason for the change.
  3. Add or update tests for behavior changes.
  4. Update documentation when commands, config, or pricing data changes.
  5. Do not include API keys, task history, or private repository names.

Pricing Updates

Pricing should be in USD per million tokens. If a provider publishes CNY pricing, include the converted USD values and keep the source currency in the _cny field when useful.