Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
27 lines (21 loc) · 766 Bytes

CONTRIBUTING.md

File metadata and controls

27 lines (21 loc) · 766 Bytes

Contributing

Thanks for helping improve SCEP-Simulator!

Development setup

  1. Create a virtualenv and install requirements.txt.
  2. Run ruff check . and pytest before pushing.

Branching & PRs

  • Create feature branches from main: feature/<short-name>
  • Link issues, include before/after screenshots for UI changes.
  • One PR = one logical change. Keep it small.

Commit style

Conventional commits recommended:

  • feat: add phase map sweep
  • fix: amortize breaker burn slices
  • chore: bump ruff
  • docs: update README

Testing

  • Add at least one smoke test for new code paths.
  • Keep tests deterministic (seeded RNG).

Releases

  • Use GitHub Releases with tags vX.Y.Z.
  • Attach release notes + checksums of exported artifacts if any.