Contributing¶

Setup¶

# Fork on GitHub, then clone
git clone https://github.com/YOUR_USERNAME/a2c_ase.git
cd a2c_ase

# Install with dev dependencies
pip install -e ".[dev,test]"

# Set up pre-commit hooks
pre-commit install

# Create branch
git checkout -b feature/your-feature-name

Development¶

Code Quality¶

ruff check        # Lint
ruff format       # Format
ty check          # Type check
pytest            # Test

Documentation¶

pip install -e ".[docs]"
mkdocs serve      # Preview

Code Standards¶

PEP 8: Enforced by ruff
Type hints: Required for all functions
Docstrings: NumPy-style format
Tests: Required for new features

Docstring Template¶

def function(param: int) -> bool:
    """Brief description.

    Parameters
    ----------
    param : int
        Description

    Returns
    -------
    bool
        Description
    """

Testing¶

Write Tests¶

def test_feature():
    """Test description."""
    result = function(input)
    assert result == expected

Run Tests¶

pytest                    # All tests
pytest -k "pattern"       # Match pattern
pytest --cov=a2c_ase      # With coverage

Submit Changes¶

Commit¶

git add .
git commit -m "feat: description"

Prefixes: feat:, fix:, docs:, test:, refactor:

Push & PR¶

git push origin feature/your-feature-name

Create PR on GitHub with clear description.

PR Checklist¶

[ ] Tests pass
[ ] Coverage >= 80%
[ ] Type hints
[ ] Docstrings

Reporting Issues¶

Bug reports: Include description, steps to reproduce, environment, minimal example

Feature requests: Include description, use case, motivation

Resources¶

License¶

By contributing, you agree that your contributions will be licensed under the MIT License.

Thank you!