Contributing

Development Setup

1. Clone the repository:

   git clone https://github.com/your-repo/ok-cli.git
   cd ok-cli
   

2. Create a virtual environment:

   python -m venv venv
   source venv/bin/activate  # On Windows: venv\Scripts\activate
   

3. Install in development mode:

   pip install -e ".[dev]"
   

Running Tests

pytest

Building Documentation

mkdocs build

Serving Documentation Locally

mkdocs serve

Code Style

This project uses: - Black for code formatting - isort for import sorting - flake8 for linting

Pull Request Process

1. Fork the repository
2. Create a feature branch
3. Make your changes
4. Add tests if applicable
5. Update documentation
6. Submit a pull request

Adding New Commands

1. Create a new file in ok_cli/commands/
2. Implement the command function
3. Add it to the CLI in ok_cli/cli.py
4. Update documentation

Adding New Templates

1. Create template directory in ok_cli/templates/
2. Add copier.yml configuration
3. Create template files
4. Update generate.py to include the new template
5. Add documentation