Contributing to mkdocstrings-matlab

Thank you for considering contributing! Please follow these steps to get started:

1. Clone repository

Clone the repository and setup its submodules. The watermarkhu/mkdocstrings-github-fixture repository is used as a fixture repository.

git clone https://github.com/watermarkhu/mkdocstrings-github
cd mkdocstrings-github
git submodule init
git submodule update

2. Environment Setup

Install all dependencies using uv:

uv sync --all-groups

Learn more about uv: uv documentation

3. Pre-commit Hooks using prek

Set up prek hooks to ensure code quality:

uv run prek install

See: prek documentation

4. Running Tests

Run tests with pytest:

uv run pytest

See: pytest documentation

5. Pull Request Guidelines

• Pull requests should target the main branch.
• Use Conventional Commits for commit messages.

See: Conventional Commits Spec