Skip to content

Latest commit

 

History

History
68 lines (48 loc) · 2.1 KB

CONTRIBUTING.md

File metadata and controls

68 lines (48 loc) · 2.1 KB

Contributing to Morphe

Thank you for your interest in contributing to Morphe! This document provides guidelines and information for contributors.

Ways to Contribute

  • Add CAD adapters: Implement adapters for other CAD systems (Onshape, CATIA, etc.)
  • Improve existing adapters: Enhance FreeCAD, Fusion 360, SolidWorks, or Inventor adapters
  • Improve test coverage: Add tests for edge cases and new functionality
  • Report bugs: Open an issue with a clear description and reproduction steps
  • Suggest features: Propose new geometry types, constraints, or capabilities
  • Improve documentation: Fix typos, clarify explanations, or add examples

Development Setup

  1. Clone the repository:

    git clone https://github.com/codereclaimers/morphe.git
cd morphe

  2. Install in development mode with dev dependencies:

    pip install -e ".[dev]"

  3. Run the tests:

    pytest tests/

Code Style

This project uses automated tools to maintain consistent code style:

  • Black for code formatting (line length: 100)
  • Ruff for linting
  • Mypy for type checking

Before submitting a pull request, please run:

black .
ruff check .
mypy morphe --exclude 'morphe/adapters/(freecad|fusion|inventor|solidworks)/'

Adding a New CAD Adapter

All adapters are implemented in Python. To add support for a new CAD system:

  1. Create a new package: morphe/adapters/<cadname>/
  2. Implement the SketchBackendAdapter abstract base class from morphe.adapters.common
  3. Add tests in tests/test_<cadname>_adapter.py or within the adapter package
  4. Update the README to mention the new adapter

See morphe/adapters/freecad/ for a reference implementation. For Windows COM-based CAD systems (like SolidWorks or Inventor), see morphe/adapters/solidworks/ for patterns using pywin32.

Pull Request Guidelines

  • Keep changes focused and atomic
  • Add tests for new functionality
  • Update documentation as needed
  • Ensure all tests pass before submitting

Questions?

Open an issue on GitHub if you have questions or need help getting started.