Skip to content

CONTRIBUTING.md

Latest commit

 

History

History
28 lines (22 loc) · 1.27 KB

CONTRIBUTING.md

File metadata and controls

28 lines (22 loc) · 1.27 KB
Raw

Contributing to TensorMesh

Thanks for your interest in contributing!

The full contributor guide — dev environment setup, running the test suite, building the docs, code style, and the PR review process — lives in the rendered documentation:

→ docs.tensor-mesh.com/community/contributing

A 30-second summary if you're in a hurry:

  1. Got a question? → ask on Discussions Q&A or Discord.
  2. Found a bug? → file a bug report.
  3. Have an idea? → float it on Discussions → Ideas & RFCs before writing the PR for larger features.
  4. Sending a patch? → see the full contributing guide for setup, tests, docs build, and PR conventions.
  5. Sign off your commits. TensorMesh uses the Developer Certificate of Origin; every commit must end with Signed-off-by: Your Name <your@email>. Just pass -s to git commit and Git adds the line for you.