Agentic Workbench

# Contributing Thank you for your interest in contributing to Agentic Workbench! ## Development Setup ```bash # Clone the repository git clone https://github.com/yourusername/agentic-workbench.git cd agentic-workbench # Install with development dependencies uv pip install -e ".[dev]" # Install pre-commit hooks pre-commit install ``` ## Development Workflow ### 1. Create a Branch ```bash git checkout -b feature/your-feature-name ``` ### 2. Make Changes Follow the code style enforced by our tools: - **Formatting**: Ruff (auto-formatted) - **Linting**: Ruff (auto-fixed where possible) - **Type Checking**: mypy (strict mode) ### 3. Run Checks ```bash # Run all checks just check # Or individually: just lint # Linting just format # Formatting just typecheck # Type checking just test # Tests ``` ### 4. Commit Pre-commit hooks will run automatically: ```bash git add . git commit -m "feat: add your feature" ``` ### 5. Push and Create PR ```bash git push origin feature/your-feature-name ``` ## Code Style ### Python - Line length: 100 characters - Docstrings: Google style - Type hints: Required for all public APIs ### Example ```python def process_task(task: str, options: TaskOptions | None = None) -> TaskResult: """Process a task and return the result. Args: task: Natural language task description. options: Optional processing options. Returns: The result of task execution. Raises: TaskError: If the task cannot be processed. """ ... ``` ## Testing ```bash # Run all tests just test # With coverage just test-cov # Specific test pytest tests/test_workbench.py -v ``` ## Documentation ```bash # Serve docs locally just docs # Build docs just docs-build ``` ## Commit Messages Follow [Conventional Commits](https://www.conventionalcommits.org/): - `feat:` New feature - `fix:` Bug fix - `docs:` Documentation - `refactor:` Code refactoring - `test:` Tests - `chore:` Maintenance ## Questions? Open an issue or start a discussion on GitHub.