From fd08c688a61ea36fb78500ce5c00c78b8d1234eb Mon Sep 17 00:00:00 2001 From: "mqt-app[bot]" <219534693+mqt-app[bot]@users.noreply.github.com> Date: Sat, 24 Oct 2026 16:28:10 +0000 Subject: [PATCH] =?UTF-8?q?=F0=9F=93=9D=20Update=20templated=20files?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- .github/release-drafter.yml | 6 +++++- AGENTS.md | 2 ++ docs/contributing.md | 14 ++++++-------- 3 files changed, 13 insertions(+), 9 deletions(-) diff --git a/.github/release-drafter.yml b/.github/release-drafter.yml index c186b4b7..fd4fd12d 100644 --- a/.github/release-drafter.yml +++ b/.github/release-drafter.yml @@ -62,10 +62,14 @@ categories: label: "patch" - type: "version-resolver" semver-increment: "patch" -change-template: "- $TITLE (#$NUMBER) (@$AUTHOR)" +change-template: "- $TITLE (#$NUMBER) ($AUTHORS)" change-title-escapes: '\<*_&' template: | $CHANGES + ## 🤝 New Contributors + + $NEW_CONTRIBUTORS + **Full Changelog**: https://github.com/$OWNER/$REPOSITORY/compare/$PREVIOUS_TAG...v$RESOLVED_VERSION diff --git a/AGENTS.md b/AGENTS.md index ba6a42fc..ca7acda4 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -70,6 +70,8 @@ ### General +- MUST use the full project name, MQT Debugger, in documentation, code comments, + and public text. - MUST read and follow `docs/ai_usage.md`. A human must review and understand all AI-assisted work. AI assistance must not be used for contributions to issues labeled `good first issue`. diff --git a/docs/contributing.md b/docs/contributing.md index ca3c0dcb..1312364c 100644 --- a/docs/contributing.md +++ b/docs/contributing.md @@ -193,13 +193,13 @@ instructions on how to set up your development environment. Building the project requires a C++20-capable [C++ compiler](https://en.wikipedia.org/wiki/List_of_compilers#C++_compilers) -and [CMake](https://cmake.org/) 3.28 or newer. As of August 2025, our CI +and [CMake](https://cmake.org/) 3.28 or newer. As of September 2026, our CI pipeline on GitHub continuously tests the library across the following matrix of systems and compilers: -- {code}`ubuntu-24.04`: {code}`Release` and {code}`Debug` builds using +- {code}`ubuntu-26.04`: {code}`Release` and {code}`Debug` builds using {code}`gcc` -- {code}`ubuntu-24.04-arm`: {code}`Release` build using {code}`gcc` +- {code}`ubuntu-26.04-arm`: {code}`Release` build using {code}`gcc` - {code}`macos-26`: {code}`Release` and {code}`Debug` builds using {code}`AppleClang` - {code}`windows-2025`: {code}`Release` and {code}`Debug` builds using @@ -394,9 +394,8 @@ For some tips on how to write good Doxygen comments, see the The C++ API documentation is integrated into the overall documentation that we host on ReadTheDocs using the -[breathe](https://breathe.readthedocs.io/en/latest/) extension for Sphinx. - -See {ref}`working-on-documentation` for more information on how to build the +[breathe](https://breathe.readthedocs.io/en/latest/) extension for Sphinx. See +{ref}`working-on-documentation` for more information on how to build the documentation. ## Working on the Python Package @@ -572,8 +571,7 @@ uvx nox --non-interactive -s docs ``` Install the project's native build requirements first. C++ API generation needs -Doxygen; DD visualizations also need the Graphviz `dot` executable. The session -manages Python packages, not these system tools. +Doxygen. The session manages Python packages, not these system tools. Omit `--non-interactive` to serve the documentation while editing. To check external links, run: