CONTRIBUTING.md

Contributing to SplatForge

Thank you for your interest in contributing to SplatForge! This document provides guidelines for contributing.

Getting Started

1. Fork the repository
2. Clone your fork: git clone https://github.com/your-username/SplatForge.git
3. Install dependencies: pip install -e ".[dev]"
4. Run tests: pytest tests/ -v

Development Workflow

1. Create a feature branch: git checkout -b feature/your-feature
2. Make your changes
3. Write tests for new functionality
4. Ensure all tests pass: pytest tests/ -v
5. Commit with conventional commits: git commit -m "feat: add new feature"
6. Push and create a Pull Request

Commit Convention

We follow the Angular commit convention:

• feat: New features
• fix: Bug fixes
• docs: Documentation updates
• refactor: Code refactoring
• test: Test additions/changes
• chore: Build/tooling changes

Code Style

• Follow PEP 8
• Use type hints where possible
• Add docstrings to public functions and classes
• Keep functions focused and small

Reporting Issues

When reporting issues, please include:

• Python version
• Operating system
• Steps to reproduce
• Expected vs actual behavior
• Error messages/stack traces

Pull Request Guidelines

• Keep PRs small and focused
• Include tests for new functionality
• Update documentation as needed
• Ensure CI passes before requesting review

Thank you for your contributions!