Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
38 lines (27 loc) · 967 Bytes

CONTRIBUTING.md

File metadata and controls

38 lines (27 loc) · 967 Bytes
Raw

Contributing

Note: This repository is under double-blind review. Contributions are paused until the review period concludes. The information below describes the contribution workflow for the post-review release.

Code Style

  • Python 3.9+
  • Follow PEP 8; line length 100 characters
  • Use type hints for public function signatures
  • Docstrings in Google or NumPy format

Testing

pytest tests/ -v

Run the smoke test before submitting changes:

python scripts/run_smoke_test.py

Pull Request Process

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/your-feature)
  3. Add tests for new functionality
  4. Update documentation
  5. Submit a pull request

Reporting Issues

Use the issue tracker to report bugs, propose features, or ask reproducibility questions. Include:

  • Operating system and version
  • Python and TensorFlow versions
  • Minimal reproduction example
  • Expected vs. observed behaviour