112 lines (80 loc) · 1.98 KB

Contributing to Loop Engineering

Thank you for your interest in contributing to Loop Engineering! This document provides guidelines for contributing to the project.

Development Setup

Fork the repository

Clone your fork:

git clone https://github.com/chillum-codeX/loop-engineering.git
cd loop-engineering

Install in development mode:
```
pip install -e ".[dev]"
```
Run tests:
```
pytest tests/
```

Code Standards

Python: Follow PEP 8
Line length: 100 characters max
Formatting: Use black
Imports: Use isort
Types: Add type hints for new code

Pull Request Process

Create a branch for your feature:
```
git checkout -b feature/my-feature
```
Make your changes and add tests
Run the test suite:
```
pytest tests/ -v
```

Format your code:

black loop_engine/ tests/
isort loop_engine/ tests/

Commit with a clear message:

git commit -m "Add feature: description"

Push and create a PR:
```
git push origin feature/my-feature
```

Adding New Patterns

To add a new pattern:

Create docs/patterns/my-pattern.md
Add a starter template to starters/my-pattern/
Update the pattern index in docs/patterns/README.md
Add cost estimates to the CLI

Pattern template:

# My Pattern

## When
Trigger conditions

## Read
Inputs needed

## Judge
Success criteria

## Output
Deliverables

## Stop
Boundaries

Testing

Add tests for new features
Maintain >80% coverage
Test both success and failure cases

Documentation

Update README.md if needed
Add docstrings to new functions
Update API reference docs

Code of Conduct

See CODE_OF_CONDUCT.md.

Questions?

Thank you for contributing!