Skip to content

Contributing¶

Contributions are welcome! This guide will help you get started.

Ways to Contribute¶

Report bugs - Open an issue describing the problem
Suggest features - Open an issue with your idea
Improve documentation - Fix typos, clarify instructions
Submit code - Fix bugs or add features

Development Setup¶

Prerequisites¶

FreeCAD 0.21+ or 1.0+
mise - Tool version manager (optional but recommended)
Python 3.11

Clone and Setup¶

# Clone the repository
git clone https://github.com/spkane/freecad-macro-3d-print-multi-export.git
cd freecad-macro-3d-print-multi-export

# Install mise (if not already installed)
curl https://mise.run | sh

# Install tools and setup pre-commit hooks
mise trust
mise install
just setup

Running Quality Checks¶

# Run all pre-commit checks
just all

# Or run specific checks
just quality::lint          # Linting only
just quality::format        # Auto-format code
just quality::markdown-fix  # Fix markdown issues

Code Style¶

Follow PEP 8 for Python code
Use ruff for linting and formatting
Keep functions focused and well-documented
Add comments for complex logic

Pull Request Process¶

Fork the repository
Create a branch for your changes: git checkout -b feature/my-feature
Make your changes and commit them
Run quality checks: just all
Push to your fork
Open a Pull Request with a clear description

Commit Messages¶

Use Conventional Commits:

feat: add new feature
fix: resolve bug in export
docs: update installation instructions
chore: update dependencies

Testing¶

Manual Testing¶

Install the macro in FreeCAD
Test with various object types
Test all export formats
Verify file contents are correct

Test Cases to Cover¶

Documentation¶

Documentation is built with MkDocs and Material for MkDocs.

# Serve documentation locally
just documentation::serve

# Build documentation
just documentation::build

Questions?¶

Open an issue for questions about contributing
Check existing issues for similar discussions