development - zfifteen/unified-framework GitHub Wiki
Guidelines for developing and contributing to the Z Framework.
# Clone repository
git clone https://github.com/zfifteen/unified-framework
cd unified-framework
# Install development dependencies
pip install -r requirements.txt
# Setup development environment
export PYTHONPATH=$(pwd)
export Z_FRAMEWORK_PRECISION=50
- Python: 3.8+ (recommended 3.12)
- Libraries: NumPy, SciPy, mpmath, SymPy
- Testing: pytest, unittest
- Documentation: Sphinx, markdown
- main: Stable release branch
- develop: Integration branch
- feature/*: Feature development branches
- hotfix/*: Critical bug fixes
- Follow PEP 8 style guidelines
- Use type hints for all functions
- Maintain high test coverage (>90%)
- Document all public APIs
- Unit tests for all new functionality
- Integration tests for module interactions
- Performance tests for critical algorithms
- Validation tests for mathematical claims
- Use mpmath with dps=50 for all calculations
- Validate numerical stability across precision levels
- Document precision requirements for each function
- Bootstrap methods with nâĽ1000 samples
- Report confidence intervals for all empirical claims
- Use appropriate multiple testing corrections
- Mathematical derivations for all formulas
- Empirical validation results with statistical significance
- Clear distinction between proven and hypothetical results