Development Guide

Guidelines for contributing to and developing qig.

• Validation Framework
• Testing Documentation
• Testing Tolerance Framework
• Contributing Guidelines
• Notebook Development
• Notebook Output Filtering

Testing

Coming soon: Migrated from TESTING.md

Topics: - Running tests with pytest - Test structure and organization - Tolerance framework (CIP-0004) - Integration vs unit tests

Testing Tolerances

Coming soon: Numerical tolerance framework (CIP-0004)

Topics: - Scientifically-derived tolerance categories - Categories A-F (machine precision to physical validation) - Using the tolerance framework - Debugging test failures

Contributing

Coming soon: Migrated from CONTRIBUTING.md

Topics: - Code style and conventions - Pull request process - Docstring format (NumPy style) - Adding new features

Notebook Development

Coming soon: Working with Jupyter notebooks

Topics: - Notebook output filtering (nbstripout) - Notebook test fixes - Smoke tests vs full execution - Example notebooks