Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
25 lines (17 loc) · 919 Bytes

CONTRIBUTING.md

File metadata and controls

25 lines (17 loc) · 919 Bytes
Raw

Contributing to sim-cli

Thanks for your interest in sim-cli. Contributions of all sizes are welcome — bug reports, fixes, new drivers, docs, examples.

Getting started

See docs/DEVELOPMENT.md for local setup, running tests, and adding a new solver driver.

Submitting changes

  1. Fork the repo and create a topic branch off main.
  2. Make your change. Run pytest -q and ruff check src/sim tests.
  3. Open a pull request against main with a short description of the change and any context a reviewer would want.

Licensing of contributions

sim-cli is released under the Apache License, Version 2.0. By submitting a pull request, you agree that your contribution is licensed under the same Apache-2.0 terms (inbound = outbound), and you represent that you have the right to do so.

No separate Contributor License Agreement (CLA) is required at this time.