Contributing

Workflow

  1. Create a branch for your change.

  2. Implement code and/or documentation updates.

  3. Run tests locally.

  4. Open a pull request with a clear summary and validation notes.

Change Checklist

  • Tests added or updated for behavior changes.

  • Existing tests pass.

  • Documentation updated for new config keys, outputs, or runtime behavior.

  • Demo/config changes include clear run instructions.

Review Focus Areas

  • Numerical correctness and boundary behavior.

  • Backward compatibility of config handling.

  • Performance impact of new JAX code paths.

  • Output format stability for downstream analysis scripts.