Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
64 lines (45 loc) · 1.59 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 1.59 KB

Contributing

Thank you for your interest in contributing to this project!

Bug Reports & Feature Requests

Please open an issue on GitHub with:

  • A clear description of the bug or feature
  • Steps to reproduce (for bugs)
  • Expected vs. actual behavior

Development Setup

# Clone the repository
git clone https://github.com/DLR-RM/interactive-incremental-learning.git
cd interactive-incremental-learning

# Create conda environment
conda env create -f requirements.yaml
conda activate tpkmp

# Or install with pip (editable mode with test dependencies)
pip install -e ".[tests]"

Code Style

This project uses:

  • Black for code formatting (line length: 127)
  • Ruff for linting
  • mypy for static type checking

Run all checks before submitting a PR:

make commit-checks   # format + type check + lint

Or run individually:

make format          # Auto-format code
make type            # Run mypy type checking
make lint            # Run ruff linting
make check-codestyle # Check formatting without modifying

Testing

All changes must pass the existing test suite:

make pytest

If you add new functionality, please include corresponding tests.

Pull Request Process

  1. Fork the repository and create a feature branch from main
  2. Make your changes
  3. Run make commit-checks and make pytest to verify everything passes
  4. Submit a pull request with a clear description of your changes