Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension


Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion .github/workflows/templating.yml
Original file line number Diff line number Diff line change
Expand Up @@ -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: Debugger
Expand Down
2 changes: 1 addition & 1 deletion .pre-commit-config.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -119,7 +119,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]
Expand Down
27 changes: 14 additions & 13 deletions docs/installation.md
Original file line number Diff line number Diff line change
Expand Up @@ -249,7 +249,7 @@ Set up a reproducible development environment for MQT Debugger. 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: <!-- rumdl-disable-line MD013 -->
1. Get the code:

::::{tab-set}

Expand Down Expand Up @@ -295,22 +295,22 @@ guidelines and workflows, see {doc}`contributing`.

Now you can make your changes locally.

4. Install the project and its development dependencies: <!-- rumdl-disable-line MD013 -->
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 <uv-recommendation>`).
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 <uv-recommendation>`). See the [uv documentation][uv] for
more information.

::::{tab-set}
:sync-group: installer

:::{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
Expand All @@ -336,17 +336,18 @@ guidelines and workflows, see {doc}`contributing`.

::::

5. Install pre-commit hooks to ensure code quality: <!-- rumdl-disable-line MD013 -->
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}

Expand Down
Loading