Skip to content

Latest commit

 

History

History
74 lines (55 loc) · 1.54 KB

CONTRIBUTING.MD

File metadata and controls

74 lines (55 loc) · 1.54 KB

Contributing to Video Composer Agent

Thanks for your interest in contributing! Here's how to get started.

Development Setup

  1. Fork and clone the repo
git clone https://github.com/YOUR_USERNAME/video-composer-agent.git
cd video-composer-agent
  1. Install dependencies with uv
pip install uv
uv sync
  1. Set up pre-commit hooks
uv pip install pre-commit
pre-commit install

Code Style

We use several tools to ensure code quality:

  • Ruff for linting and formatting
  • Pre-commit hooks for automated checks
  • YAML/TOML validation
  • Automatic dependency updates with uv

The pre-commit hooks will run automatically when you commit. You can also run them manually:

pre-commit run --all-files

Pull Request Process

  1. Create a new branch for your feature
git checkout -b feature/your-feature-name
  1. Make your changes and commit them
git add .
git commit -m "feat: your descriptive commit message"

  1. Push to your fork and create a Pull Request

  2. Ensure your PR:

    • Passes all pre-commit checks
    • Includes relevant tests if adding new functionality
    • Updates documentation as needed
    • Has a clear description of the changes

Environment Variables

  1. Copy .env.example to .env
cp .env.example .env
  1. Add your API keys and other required variables
  2. Never commit your .env file

Need Help?

  • Join our Discord
  • Check existing issues and PRs
  • Create an issue for discussion