Play your own Switch games on iPhone/iPad — one-click macOS app, no terminal. | 把 Switch 游戏装进 iPhone:图形界面一键构建,不用命令行。Bring your own game.
Swift apple-siliconcustom-formathomebrewiosipaipadipadosiphonemetalnative-portnintendo-switchnxnativeromfsswitch-games
Add a release notes template, English first, no emojis
v0lumehiaec2a91b4fa4
diff --git a/.github/copilot-instructions.md b/.github/copilot-instructions.mdindex 0af2953a..28b80e2e 100644--- a/.github/copilot-instructions.md+++ b/.github/copilot-instructions.md@@ -11,3 +11,4 @@ Read [AGENTS.md](../AGENTS.md) (the fork's, at the root) and [CONTRIBUTING.md](.- You work on a Linux runner and cannot build or run the macOS app. The macOS jobs of `tests.yml` are the check: do not claim a Swift or Metal change works until they are green.- A PR that changes the launcher needs before and after screenshots. You cannot capture them on a Linux runner: say so under Screenshots and ask for them in the PR (CONTRIBUTING.md, "For AI agents and other tools").- Issues and PRs follow the forms and the PR template (CONTRIBUTING.md, "For AI agents and other tools").+- Release notes follow `.github/release_notes_template.md`, English first, no emojis.diff --git a/.github/release_notes_template.md b/.github/release_notes_template.mdnew file mode 100644index 00000000..b672af9c--- /dev/null+++ b/.github/release_notes_template.md@@ -0,0 +1,57 @@+<!--+Template for the notes of a release. Copy it to a file, fill it in, delete these comments and the groups that stay empty.+Publish with `gh release edit <tag> --notes-file <file>`. Never paste notes from a chat: pasted text brings emojis along.++Rules (RELEASING.md, "Release notes" has the same list):+- English first, Chinese second, with the same content in both.+- No emojis, no pictograms and no symbols in the text (no warning signs, no flags, no arrows).+- No semicolons (also not the full-width one), no em-dashes (also not the Chinese double dash).+- Plain English and plain Chinese. Short sentences.+- People are written as @login, the owner as @LNPANDY.+- Every claim comes from the changelog row, the merged PRs or the issues. Nothing is invented.+- Write the notes before the final tag is pushed or right after it. CI only writes a short body at first.+-->++<!-- One line: the version and what it is about. Same in both parts if you keep it. -->+**vX.Y.Z: the one thing this release is about.**++## English++<!-- First paragraph, only when players must act, for example "update now". Bold, plain words, no symbol. Then what to do and where to read more. Delete it when no action is needed. -->+**On 0.7.3 or older? Update now.** One sentence on what breaks and one on what the update does. Details: link.++<!-- One group per kind of change, in this order. A bullet is a bold lead, a colon, a short plain explanation and the numbers as #N. -->+**New**+- **Lead of the change**: what a player can do now, in one or two sentences (#N, #M)++**Fixed**+- **Lead of the fix**: what went wrong and what happens now (#N)++**Known issues**+- **Lead of the issue**: what does not work yet and what to do meanwhile (#N)++<!-- Optional, only when something needs a word that is not a change: for example a new requirement or a changed default. -->+**Note**+- **Lead**: the point in one sentence++## 中文++<!-- The same content as English, in the same order, with the same numbers. Not a second set of facts. -->+**App 版本是 0.7.3 或更早?请立即更新。** 一句话说明什么会出问题,一句话说明更新后会怎样。详情:链接。++**新增**+- **改动的标题**:玩家现在能做什么,一两句话(#N、#M)++**修复**+- **修复的标题**:原来哪里出错,现在会怎样(#N)++**已知问题**+- **问题的标题**:哪里还不能用,暂时怎么办(#N)++**说明**+- **标题**:一句话说明要点++---++<!-- The install line closes the notes (v0.7.2 and v0.7.3 had it). Keep it for a final release. A release candidate gets its own body from CI. -->+**Install:** download `NX2Apple-macOS-arm64.zip`, unzip, drag it to Applications. 中文:下载后解压,拖进「应用程序」。diff --git a/AGENTS.md b/AGENTS.mdindex edf3cd75..684213c8 100644--- a/AGENTS.md+++ b/AGENTS.md@@ -12,3 +12,4 @@ This is the fork's guide. The engine has its own, upstream's: [engine/AGENTS.md]- **Merging with admin rights.** An admin merge never goes over a red check. That holds even when @LNPANDY overrides an objection. If a re-review is slow, the other maintainer pings the reviewer and does not merge with admin rights.- **Checks.** `cd frontend && swift build && swift test` for the Mac launcher (its tests read `engine/`, so sync first), `python3 -m unittest discover -s frontend-qt/tests` for the Qt front end (and `python3 frontend-qt/gen_localization.py` leaves `frontend-qt/nspb_qt/localization.py` unchanged), `python3 -m unittest discover tools/tests` for the tools. The engine's own tests run in `engine/` as `tests.yml` does. The pre-commit hook runs `python3 tools/engine.py check` when `patches/` or `.upstream-ref` is staged. The pre-push hook runs the checks above for the files the push changes, `tools/githooks.py` has the list. Fix the failure, do not bypass the hook.- **Language and text.** Everything is in English except the Chinese pages (`*.zh-CN.md`) and the launcher's strings. No semicolons in UI strings, READMEs and docs.+- **Release notes.** Release notes follow `.github/release_notes_template.md`, English first, no emojis.diff --git a/CONTRIBUTING.md b/CONTRIBUTING.mdindex 0e19fb14..cd5795d6 100644--- a/CONTRIBUTING.md+++ b/CONTRIBUTING.md@@ -78,4 +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 `` 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`, English first, 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.mdindex 021a7e04..9dc5dc36 100644--- a/RELEASING.md+++ b/RELEASING.md@@ -53,6 +53,17 @@ The build of the final tag looks for the newest `v0.7.6-rcN` on its commit. It dA final tag on a commit without a candidate fails. In an emergency, a manual run on the tag publishes it anyway: `gh workflow run build-mac-app.yml --ref v0.7.6 -f release_without_rc=true`. Nobody tested that build as a whole, and the release notes say so.+## Release notes++CI writes a short body: the version and the tested candidate. The readable notes are written by a person or an agent from [.github/release_notes_template.md](.github/release_notes_template.md).++- English first, Chinese second, under `## English` and `## 中文`, with the same content in both.+- No emojis, no pictograms and no symbols in the text. No semicolons (also not the full-width one) and no em-dashes. Plain English and plain Chinese.+- 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.+- The notes of a published release stay as they are, unless a fact in them is wrong.+## Who tags- Release candidates: LNPANDY or v0lumehi.