Contributing¶

Contributions to CubeForge are welcome! This page explains how to contribute to the project.

Getting Started¶

Fork the repository on GitHub

Clone your fork locally:

git clone https://github.com/Teddy-van-Jerry/cubeforge.git
cd cubeforge

Install the package in development mode:
```
pip install -e .
```
Create a new branch for your changes:
```
git checkout -b feature/my-new-feature
```

Development Workflow¶

Testing¶

CubeForge currently uses example-based testing. Run the examples to verify functionality:

python examples/create_shapes.py
python examples/coordinate_systems.py
python examples/mesh_optimization.py

All examples should run without errors and produce valid STL files.

Code Style¶

Follow PEP 8 style guidelines
Use meaningful variable and function names
Add docstrings to all public functions and classes
Keep functions focused and modular

Documentation¶

When adding new features:

Update relevant documentation in docs/
Add examples demonstrating the feature
Update the changelog in docs/changelog.rst

Building Documentation¶

To build documentation locally:

cd docs
pip install -r requirements.txt
make html

The built documentation will be in docs/_build/html/.

Submitting Changes¶

Commit your changes with a clear commit message:

git add .
git commit -m "Add feature: description of feature"

Push to your fork:
```
git push origin feature/my-new-feature
```
Open a pull request on GitHub
Wait for review and address any feedback

Pull Request Guidelines¶

One feature per PR: Keep pull requests focused on a single feature or fix
Clear description: Explain what your changes do and why
Test your changes: Ensure examples run successfully
Update documentation: Include relevant documentation updates
Follow code style: Maintain consistency with existing code

Reporting Issues¶

If you find a bug or have a feature request:

Check if the issue already exists in the issue tracker
If not, create a new issue with:
- Clear description of the problem or feature
- Steps to reproduce (for bugs)
- Expected vs actual behavior
- Python version and operating system
- Minimal code example (if applicable)

Areas for Contribution¶

Some areas where contributions would be particularly welcome:

Additional export formats: OBJ, PLY, etc.
Import functionality: Load existing meshes
Performance optimizations: Faster mesh generation
Unit tests: Comprehensive test suite
Examples: More complex use cases
Documentation: Improved guides and tutorials

Code of Conduct¶

Be respectful and inclusive
Focus on constructive feedback
Help maintain a welcoming environment
Follow the project’s coding standards

License¶

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

Questions?¶

If you have questions about contributing, feel free to:

Open a discussion on GitHub
Ask in a pull request
Contact the maintainers

Thank you for contributing to CubeForge!