Skip to content

Play your own Switch games on iPhone/iPad — one-click macOS app, no terminal. | 把 Switch 游戏装进 iPhone:图形界面一键构建,不用命令行。Bring your own game.

Release notes: bold lead in CONTRIBUTING, keep the generated block unedited and last

v0lumehief030ec113b9
diff --git a/.github/release_notes_template.md b/.github/release_notes_template.md
index a61e6d8f..fddfb7bc 100644
--- a/.github/release_notes_template.md
+++ b/.github/release_notes_template.md
@@ -76,7 +76,7 @@ Rules (RELEASING.md, "Release notes" has the same list):
**Install:** download `NX2Apple-macOS-arm64.zip`, unzip, drag it to Applications. 中文:下载后解压,拖进「应用程序」。
<!--
-Last, append the generated notes. They list the merged PRs with their authors and name first-time contributors. They are English only and not edited by hand. They replace a hand-written Credits section. Make them with:
+Last, append the generated notes. They list the merged PRs with their authors and name first-time contributors. They are English only and not edited by hand. They replace a hand-written Credits section. Keep the block unedited and last: its @login mentions and the Full Changelog link (the compare view, so the commit history since the last release) are what list the contributors and the history. Make them with:
gh api repos/LNPANDY/NX2Apple/releases/generate-notes -f tag_name=<tag> -f previous_tag_name=<previous final tag> --jq .body
and add the output to the end of the notes file, below the install line. .github/release.yml sets the categories.
-->
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 63f5bf1f..e2069b81 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -78,5 +78,5 @@ Issue forms and the PR template apply in the browser only. `gh issue create`, th
- **Ideas and plans.** These have no form. Write plain sections that fit the content, for example `### Idea`, `### Plan` and `### Done when`. Leave out the problem fields (`This is`, `NX2Apple version`, `Computer and OS`, `Copy diagnostics`). Open it with the labels `idea` and `no-triage`.
- **Pull requests.** Use the sections of [.github/pull_request_template.md](.github/pull_request_template.md): `gh pr create --template .github/pull_request_template.md`, or the same headings in `--body`. Answer each section and remove the `<!-- -->` hints. Under Fix or feature, tick one box. A change to the engine follows the rule above.
- **Screenshots.** A PR that changes the launcher needs before and after images in its body (see "A pull request"). On a Mac, capture the changed views of `frontend/` with `NX_LAUNCHER_CAPTURE_DIR=<dir> swift test` and `NX_CAPTURE_LANG` for the language (`de`, `sv` or `zh`, English is the default). `frontend-qt/` has no capture, so take its screenshots by hand. Attach the images with `gh pr create --attach` or `gh pr edit --attach`, once per file. Write `![before](./before.png)` in the body and pass `--attach ./before.png`. `gh` uploads the file and rewrites the path to a `https://github.com/user-attachments/assets/...` URL. This needs `gh` 2.99.0 or newer, push access to the repository, and an OAuth or personal access token (a GitHub App token is rejected). Afterwards, read the body back and check that it holds the asset URLs and no local paths. If your `gh` or token cannot attach, say so under Screenshots, give the paths of the captures, and ask the user to attach them. An agent without a Mac (a Linux runner) says under Screenshots that it could not capture the views and asks for screenshots in the PR.
-- Release notes follow `.github/release_notes_template.md`, Chinese first, then English, no emojis.
+- **Release notes.** They follow `.github/release_notes_template.md`, Chinese first, then English, no emojis.
- Never attach or commit keys, game files or data extracted from a game, and do not paste key values into a log or a diagnostics report.
diff --git a/RELEASING.md b/RELEASING.md
index 1fd07d37..997b5937 100644
--- a/RELEASING.md
+++ b/RELEASING.md
@@ -62,7 +62,7 @@ CI writes a short body: the version and the tested candidate. The readable notes
- People are written as `@login`, the owner as `@LNPANDY`.
- Every claim comes from the changelog row, the merged pull requests or the issues. Nothing is invented.
- Write the notes before the final tag is pushed or right after it. Put them in a file and publish with `gh release edit <tag> --notes-file <file>`. Never paste them from a chat, that brings emojis along.
-- After the two parts, append the generated notes: `gh api repos/LNPANDY/NX2Apple/releases/generate-notes -f tag_name=<tag> -f previous_tag_name=<previous final tag> --jq .body`, written into the notes file before `gh release edit`. They are English only and not edited by hand. They list the merged pull requests with their authors and name first-time contributors, so they replace a hand-written Credits section. [.github/release.yml](.github/release.yml) sets their categories. Titles of pull requests show up as written, so write them without em-dashes.
+- After the two parts, append the generated notes: `gh api repos/LNPANDY/NX2Apple/releases/generate-notes -f tag_name=<tag> -f previous_tag_name=<previous final tag> --jq .body`, written into the notes file before `gh release edit`. They are English only and not edited by hand. They list the merged pull requests with their authors and name first-time contributors, so they replace a hand-written Credits section. [.github/release.yml](.github/release.yml) sets their categories. Keep the generated block unedited and last: its `@login` mentions and the Full Changelog link (the compare view, so the commit history since the last release) are what list the contributors and the history. Titles of pull requests show up as written, so write them without em-dashes.
## Who tags