Contributing - zfifteen/unified-framework GitHub Wiki

Contributing

How to contribute

  • Fork the repo and open a pull request with descriptive changes.
  • Include tests for any numerical or algorithmic changes.
  • Use mpmath for precision-sensitive units.

Code style

  • Clear docstrings with assumptions and validation status.
  • Keep functions small and numerically explicit.
  • When introducing heuristics, label them and provide empirical evidence.

Issue reporting

  • Provide reproducible steps and minimal examples.
  • Tag issues with domain: #physical or #discrete and #validation.

Community

  • Maintain scientific tone; prefer simple, reproducible methods.