Skip to content

Latest commit

 

History

History
21 lines (15 loc) · 788 Bytes

CONTRIBUTING.md

File metadata and controls

21 lines (15 loc) · 788 Bytes

Contributing

Some ways to contribute to mink:

  • Try out the examples and report any issue.
  • Pick something you want to do with one of the many robot descriptions and write a new example.
  • Find a use case that is not covered and write a unit test for it.
  • Improve the documentation.
  • Implement new tasks or constraints.

If any of those sound interesting, open an issue and say you're on it!

Documentation

If you're adding new functionality to mink and want to update the documentation, you can build it and visualize it locally using the following:

uv pip install -r docs/requirements.txt
sphinx-build docs _build -W
open _build/index.html