diff --git a/.github/workflows/templating.yml b/.github/workflows/templating.yml index 64f2f664..cde8194c 100644 --- a/.github/workflows/templating.yml +++ b/.github/workflows/templating.yml @@ -24,7 +24,7 @@ jobs: private-key: ${{ secrets.APP_PRIVATE_KEY }} permission-contents: write # Needed to push the templating branch permission-pull-requests: write # Needed to open the templating pull request - - uses: munich-quantum-toolkit/templates@93e56d3f8ad374d6bef4e57591a02bb5c6c03675 # v1.5.3 + - uses: munich-quantum-toolkit/templates@cf0390a674091c1a428c5c59b90d48c7a38dd51c # v1.6.0 with: token: ${{ steps.create-token.outputs.token }} name: ProblemSolver diff --git a/.pre-commit-config.yaml b/.pre-commit-config.yaml index 9f7263dd..b7a9eb90 100644 --- a/.pre-commit-config.yaml +++ b/.pre-commit-config.yaml @@ -120,7 +120,7 @@ repos: ## Format Markdown files with rumdl - repo: https://github.com/rvben/rumdl-pre-commit - rev: v0.2.79 + rev: v0.3.0 hooks: - id: rumdl args: [--fix] diff --git a/docs/installation.md b/docs/installation.md index b6a9004c..04c4cf7f 100644 --- a/docs/installation.md +++ b/docs/installation.md @@ -125,7 +125,7 @@ Set up a reproducible development environment for MQT ProblemSolver. This is the recommended starting point for both bug fixes and new features. For detailed guidelines and workflows, see {doc}`contributing`. -1. Get the code: +1. Get the code: ::::{tab-set} @@ -171,14 +171,13 @@ guidelines and workflows, see {doc}`contributing`. Now you can make your changes locally. -4. Install the project and its development dependencies: +4. Install the project and its development dependencies: We highly recommend using modern, fast tooling for the development workflow. - We recommend using [{code}`uv`][uv]. - If you don't have {code}`uv`, - follow the installation instructions in the recommendation above - (see {ref}`tip above `). - See the [uv documentation][uv] for more information. + We recommend using [{code}`uv`][uv]. If you don't have {code}`uv`, follow the + installation instructions in the recommendation above (see + {ref}`tip above `). See the [uv documentation][uv] for + more information. ::::{tab-set} :sync-group: installer @@ -186,7 +185,8 @@ guidelines and workflows, see {doc}`contributing`. :::{tab-item} {code}`uv` _(recommended)_ :sync: uv - Install the project (including development dependencies) with [{code}`uv`][uv]: + Install the project (including development dependencies) with + [{code}`uv`][uv]: ```console uv sync @@ -212,17 +212,18 @@ guidelines and workflows, see {doc}`contributing`. :::: -5. Install pre-commit hooks to ensure code quality: +5. Install pre-commit hooks to ensure code quality: - The project uses pre-commit hooks for running linters and formatting tools on each commit. - These checks can be run manually via [{code}`nox`][nox], by running: + The project uses pre-commit hooks for running linters and formatting tools on + each commit. These checks can be run manually via [{code}`nox`][nox], by + running: ```console nox -s lint ``` - They can also be run automatically on every commit via [{code}`prek`][prek] (recommended). To set - this up, install {code}`prek`, e.g., via: + They can also be run automatically on every commit via [{code}`prek`][prek] + (recommended). To set this up, install {code}`prek`, e.g., via: ::::{tab-set}