Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
74 lines (52 loc) · 1.53 KB

CONTRIBUTING.md

File metadata and controls

74 lines (52 loc) · 1.53 KB

Contributing to AI Studio Proxy API

Thank you for your interest in contributing! We welcome bug reports, feature requests, and pull requests.

Getting Started

Fork & Clone

git clone https://github.com/YOUR_USERNAME/AIstudioProxyAPI.git
cd AIstudioProxyAPI

Install Dependencies

# Install Poetry (if not already installed)
curl -sSL https://install.python-poetry.org | python3 -

# Install dependencies
poetry install --with dev

Run the Test Suite

poetry run pytest

Making Changes

  1. Create a branch: git checkout -b feature/your-feature
  2. Make your changes
  3. Run checks before committing: 
    poetry run ruff check .
poetry run ruff format .
poetry run pyright
poetry run pytest
  4. Commit using Conventional Commits:
    • feat: New feature
    • fix: Bug fix
    • docs: Documentation
    • refactor: Code restructuring
  5. Open a Pull Request

Code Style

We use:

  • Ruff for linting and formatting
  • Pyright for type checking
  • 80% test coverage minimum for modified files

See Development Guide for detailed coding conventions.

Reporting Issues

Please include:

  • Steps to reproduce
  • Expected vs actual behavior
  • Python version and OS
  • Relevant logs (from errors_py/ if available)

Questions?

License

Contributions are licensed under AGPLv3.