Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
66 lines (48 loc) · 1.63 KB

CONTRIBUTING.md

File metadata and controls

66 lines (48 loc) · 1.63 KB
Raw

Contributing to aiusage

Thanks for your interest in contributing! This document explains how to get involved.

Getting Started

git clone https://github.com/juliantanx/aiusage.git
cd aiusage
pnpm install
pnpm build

Development

# Start in dev mode (builds core + web, then runs CLI dev server)
pnpm dev

# Run tests
pnpm test

# Lint
pnpm lint

Project Structure

packages/
  core/     - Shared types, database schema, pricing data, utilities
  cli/      - Published CLI, parsers, local API server, sync, PM2 helpers
  web/      - Local SvelteKit dashboard bundled into the CLI
  widget/   - Electron tray/menu-bar widget
  site/     - Official website, docs, accounts, uploads, leaderboard

Submitting Changes

  1. Fork the repository
  2. Create a feature branch: git checkout -b feat/my-feature
  3. Make your changes
  4. Run tests: pnpm test
  5. Commit with a clear message following Conventional Commits: 
    feat: add new feature
fix: resolve bug
docs: update documentation
  6. Push to your fork and open a Pull Request

Reporting Bugs

Use the Bug Report template. Include:

  • Steps to reproduce
  • Expected vs actual behavior
  • OS, Node.js version, aiusage version (aiusage status)

Feature Requests

Use the Feature Request template. Describe the use case and why it matters.

Questions?

Open a Discussion or check the existing issues.