42 lines (30 loc) · 1.25 KB

Contributing

Thanks for your interest in contributing to mink! Here are a few great ways to get involved:

Try out the examples and report any issues.
Pick something you'd like to do with one of the many robot descriptions and write a new example.
Find a use case that isn’t covered yet 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 let us know you're on it!

Pull Requests

When submitting a pull request, please make sure to:

Update the changelog with a short description of your change.
Run all tests locally to ensure nothing is broken. You can do this with:
```
pytest .
```

If you’re adding new functionality, consider adding corresponding tests and updating the docs if applicable.

Documentation

If you’re adding new functionality to mink and want to update the documentation, you can build it and preview it locally like this:

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

Thanks again for helping make mink better!