Skip to content

Commit de1ea24

Browse files
authored
📝 Update templated files (#37)
This pull request updates the files in this repository with the latest changes from the MQT Templates repository. For details on the respective changes, see the [changelog](https://github.com/munich-quantum-toolkit/templates/blob/main/CHANGELOG.md) as well as the [upgrade guide](https://github.com/munich-quantum-toolkit/templates/blob/main/UPGRADING.md). Co-authored-by: mqt-app[bot] <219534693+mqt-app[bot]@users.noreply.github.com>
1 parent 0604477 commit de1ea24

9 files changed

Lines changed: 503 additions & 615 deletions

File tree

.github/CONTRIBUTING.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,6 @@
33

44
# Contributing
55

6-
Thank you for your interest in contributing to MQT SCPD!
7-
An extensive contribution guide is available in our
6+
Thank you for your interest in contributing to MQT SCPD! An extensive
7+
contribution guide is available in our
88
[documentation](https://mqt.readthedocs.io/projects/scpd/en/latest/contributing.html).

.github/SECURITY.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -9,10 +9,8 @@ Security updates are applied only to the most recent releases.
99

1010
## Reporting a Vulnerability
1111

12-
To report vulnerabilities,
13-
you can privately report a potential security issue via the GitHub security
14-
vulnerabilities feature.
15-
This can be done here:
12+
To report vulnerabilities, you can privately report a potential security issue
13+
via the GitHub security vulnerabilities feature. This can be done here:
1614

1715
<https://github.com/munich-quantum-toolkit/scpd/security/advisories>
1816

.github/SUPPORT.md

Lines changed: 7 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -3,20 +3,17 @@
33

44
# Support
55

6-
If you are stuck with a problem using MQT SCPD or have questions,
7-
please get in touch at our [Issues] or [Discussions].
8-
We'd love to help.
6+
If you are stuck with a problem using MQT SCPD or have questions, please get
7+
in touch at our [Issues] or [Discussions]. We'd love to help.
98

109
You can save time by following this procedure when reporting a problem:
1110

1211
- Do try to solve the problem on your own first.
13-
- Search through past [Issues] and [Discussions] to see
14-
if someone else already had the same problem.
15-
- Before filing a bug report,
16-
try to create a minimal reproducible example (MRE)
17-
that reproduces the problem.
18-
It is much easier to identify the cause for the problem
19-
if a handful of lines suffice to show that something is not working.
12+
- Search through past [Issues] and [Discussions] to see if someone else already
13+
had the same problem.
14+
- Before filing a bug report, try to create a minimal reproducible example (MRE)
15+
that reproduces the problem. It is much easier to identify the cause for the
16+
problem if a handful of lines suffice to show that something is not working.
2017

2118
You can also always reach us at
2219
[quantum.cda@xcit.tum.de](mailto:quantum.cda@xcit.tum.de).

.github/renovate.json5

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -81,7 +81,7 @@
8181
automerge: true,
8282
},
8383
{
84-
description: "Disable minimum release age checks for our own GitHub Actions",
84+
description: "Disable minimum release age checks for our own GitHub actions",
8585
matchManagers: ["github-actions"],
8686
matchPackageNames: [
8787
"munich-quantum-toolkit/*",

AGENTS.md

Lines changed: 24 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -36,14 +36,14 @@
3636

3737
### C++
3838

39-
- Targets Linux (glibc 2.28+), macOS (11.0+),
40-
and Windows on x86_64 and arm64 architectures
39+
- Targets Linux (glibc 2.28+), macOS (11.0+), and Windows on x86_64 and arm64
40+
architectures
4141
- C++20
4242
- CMake 3.24+
43-
- `FetchContent` for dependency management
44-
(configured in `cmake/ExternalDependencies.cmake`)
45-
- `clang-format` and `clang-tidy` for formatting/linting
46-
(see `.clang-format` and `.clang-tidy`)
43+
- `FetchContent` for dependency management (configured in
44+
`cmake/ExternalDependencies.cmake`)
45+
- `clang-format` and `clang-tidy` for formatting/linting (see `.clang-format`
46+
and `.clang-tidy`)
4747
- GoogleTest for unit tests (located in `test/`)
4848

4949
### Python
@@ -69,12 +69,11 @@
6969

7070
### General
7171

72-
- MUST run `uvx nox -s lint` after every batch of changes.
73-
This runs the full `prek` hook set from `.pre-commit-config.yaml`
74-
(including `ruff`, `typos`, `ty`, formatting, and metadata checks).
75-
All hooks must pass before submitting.
76-
- MUST add or update tests for every code change,
77-
even if not explicitly requested.
72+
- MUST run `uvx nox -s lint` after every batch of changes. This runs the full
73+
`prek` hook set from `.pre-commit-config.yaml` (including `ruff`, `typos`,
74+
`ty`, formatting, and metadata checks). All hooks must pass before submitting.
75+
- MUST add or update tests for every code change, even if not explicitly
76+
requested.
7877
- MUST follow existing code style by checking neighboring files for patterns.
7978
- MUST update `CHANGELOG.md` and `UPGRADING.md` when changes are user-facing,
8079
breaking, or otherwise noteworthy.
@@ -83,9 +82,8 @@
8382
`Assisted-by: Claude Sonnet 4.6 via GitHub Copilot`) if AI tools are used to
8483
prepare a commit.
8584
- NEVER modify files that start with "This file has been generated from an
86-
external template.
87-
Please do not modify it directly."
88-
These files are managed by
85+
external template. Please do not modify it directly." These files are managed
86+
by
8987
[the MQT templates action](https://github.com/munich-quantum-toolkit/templates)
9088
and changes will be overwritten.
9189
- PREFER running targeted tests over the full test suite during development.
@@ -94,31 +92,28 @@
9492

9593
- MUST use Doxygen-style comments.
9694
- MUST use `#pragma once` for header guards.
97-
- MUST regenerate stubs via `uvx nox -s stubs`
98-
when files in `bindings/` are added or modified.
99-
- NEVER edit `.pyi` files in `python/mqt/scpd/` manually;
100-
they are auto-generated by nanobind stubgen.
95+
- MUST regenerate stubs via `uvx nox -s stubs` when files in `bindings/` are
96+
added or modified.
97+
- NEVER edit `.pyi` files in `python/mqt/scpd/` manually; they are
98+
auto-generated by `nanobind.stubgen`.
10199
- PREFER C++20 STL features over custom implementations.
102100

103101
### Python
104102

105103
- MUST use Google-style docstrings
106104
- PREFER running a single Python version over the full test suite during
107105
development.
108-
- PREFER fixing reported warnings over suppressing them
109-
(e.g., with `# noqa` comments for ruff);
110-
only add ignore rules when necessary and document why.
111-
- PREFER fixing typing issues reported by `ty`
112-
before adding suppression comments
113-
(`# ty: ignore[code]`);
114-
suppressions are sometimes necessary for incompletely typed libraries
115-
(e.g., Qiskit).
106+
- PREFER fixing reported warnings over suppressing them (e.g., with `# noqa`
107+
comments for ruff); only add ignore rules when necessary and document why.
108+
- PREFER fixing typing issues reported by `ty` before adding suppression
109+
comments (`# ty: ignore[code]`); suppressions are sometimes necessary for
110+
incompletely typed libraries (e.g., Qiskit).
116111

117112
## Self-Review Checklist
118113

119114
- Did `uvx nox -s lint` pass without errors?
120115
- Are all changes covered by at least one automated test?
121-
- Were Python stubs regenerated via `uvx nox -s stubs`
122-
if bindings were modified?
116+
- Were Python stubs regenerated via `uvx nox -s stubs` if bindings were
117+
modified?
123118
- Are `CHANGELOG.md` and `UPGRADING.md` updated when changes are user-facing,
124119
breaking, or otherwise noteworthy?

0 commit comments

Comments
 (0)