Skip to content

Commit 51f7b14

Browse files
authored
📝 Update templated files
1 parent 5a3dd95 commit 51f7b14

9 files changed

Lines changed: 467 additions & 574 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 Debugger!
7-
An extensive contribution guide is available in our
6+
Thank you for your interest in contributing to MQT Debugger! An extensive
7+
contribution guide is available in our
88
[documentation](https://mqt.readthedocs.io/projects/debugger/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/debugger/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 Debugger 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 Debugger 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,21 +69,19 @@
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 include a commit footer attribution in the form
8079
`Assisted-by: [Model Name] via [Tool Name]` (example:
8180
`Assisted-by: Claude Sonnet 4.6 via GitHub Copilot`) if AI tools are used to
8281
prepare a commit.
8382
- NEVER modify files that start with "This file has been generated from an
84-
external template.
85-
Please do not modify it directly."
86-
These files are managed by
83+
external template. Please do not modify it directly." These files are managed
84+
by
8785
[the MQT templates action](https://github.com/munich-quantum-toolkit/templates)
8886
and changes will be overwritten.
8987
- PREFER running targeted tests over the full test suite during development.
@@ -92,29 +90,26 @@
9290

9391
- MUST use Doxygen-style comments.
9492
- MUST use `#pragma once` for header guards.
95-
- MUST regenerate stubs via `uvx nox -s stubs`
96-
when files in `bindings/` are added or modified.
97-
- NEVER edit `.pyi` files in `python/mqt/debugger/` manually;
98-
they are auto-generated by nanobind stubgen.
93+
- MUST regenerate stubs via `uvx nox -s stubs` when files in `bindings/` are
94+
added or modified.
95+
- NEVER edit `.pyi` files in `python/mqt/debugger/` manually; they are
96+
auto-generated by `nanobind.stubgen`.
9997
- PREFER C++20 STL features over custom implementations.
10098

10199
### Python
102100

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

115110
## Self-Review Checklist
116111

117112
- Did `uvx nox -s lint` pass without errors?
118113
- Are all changes covered by at least one automated test?
119-
- Were Python stubs regenerated via `uvx nox -s stubs`
120-
if bindings were modified?
114+
- Were Python stubs regenerated via `uvx nox -s stubs` if bindings were
115+
modified?

0 commit comments

Comments
 (0)