Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
43 lines (29 loc) · 1.01 KB

CONTRIBUTING.md

File metadata and controls

43 lines (29 loc) · 1.01 KB

Contributing to x-cli

We welcome contributions! Please read this document before getting started.

Development Setup

Prerequisites

  • Node.js 18+
  • Python 3.9+
  • Git

TypeScript Client

  1. Navigate to source/ts-cli.
  2. Install dependencies: npm install.
  3. Run build: npm run build.
  4. Run tests: npm test.
  5. Run dev mode: npm run dev (if available) or npm start.

Python Client

  1. Navigate to source/py-cli.
  2. Create a virtual env: python -m venv venv && source venv/bin/activate.
  3. Install editable: pip install -e .[dev].
  4. Run tests: pytest.

Code Style

  • TS: We use xo / eslint and prettier. Run npm run lint.
  • Python: We use black and flake8.

Pull Request Process

  1. Fork the repository.
  2. Create a feature branch.
  3. Add tests for your changes.
  4. Ensure all tests pass.
  5. Submit a PR with a clear description.

Commit Messages

Please follow the Conventional Commits specification (e.g., feat: add search, fix: handle 429).