From 718b3800a591b2aca12b2bf983c18704324403d9 Mon Sep 17 00:00:00 2001 From: dazhi Date: Mon, 9 Nov 2026 16:00:23 +0800 Subject: [PATCH 1/2] docs: suggest a short PR opener with the long description folded Most PR descriptions here are agent-written and run to 40-140 lines. Ask for a one-to-three sentence opener, keep what reviewers check in view (tested environment, unverified behaviour, remaining warnings, new access or minimum version), and fold the rest in
, following https://simonwillison.net/2026/Nov/9/details-summary/. It is a suggestion, not a review gate. Assisted-by: Claude Opus 5.5 (OpenCode) --- AGENTS.md | 8 ++++++++ CONTRIBUTING.md | 2 +- CONTRIBUTING.zh-CN.md | 2 +- 3 files changed, 10 insertions(+), 2 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index b95e1356..f7875add 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -26,6 +26,12 @@ package at `plugins///`; the rest change the checks 4. Add one row to the table in both root READMEs. 5. Run `npm run check`. Done when it reports no errors and every warning is either fixed or explained in the PR description. +6. Open the PR with a short opener: one to three sentences on what changed and why, plus a + screenshot when the page looks different. Keep these visible below it: the tested environment + and results, what you did not verify, each remaining `npm run check` warning with its reason, + and any new access or higher minimum client version. Put the rest of a long description inside + `
Written by …
`. Ask the person you work for to + read and edit the opener before you submit. ## Hard rules @@ -90,6 +96,8 @@ suggestion. - CI validates every package under `plugins/`. A new error must leave existing packages at zero errors; otherwise ship it as a warning first. - Keep contract changes in their own PR, apart from package updates. +- Describe the PR as in step 6 of "Add or update a Mini App": a short opener, what was and was + not verified in view, the rest folded. ## Navigation diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 36d259d8..cc1af979 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,6 @@ The plugin directory name must match `name` in `.minimax-plugin/plugin.json`. ** Submit ready-to-run files. If the app requires a build step, include its source and build instructions. Do not commit `node_modules/`, credentials, real session records, personal data, or runtime caches. Use synthetic or thoroughly anonymized data in screenshots and examples. -Before submitting, install the app in MiniMax Code, open it, and check its main features. Include your test environment and results in the pull request, and state any unverified behavior. When updating an existing app, keep its plugin ID and update the version and usage instructions as appropriate. +Before submitting, install the app in MiniMax Code, open it, and check its main features. Include your test environment and results in the pull request, and state any unverified behavior. If an AI agent wrote the description, write its first two or three sentences yourself, keep the test results and unverified behavior visible, and fold the rest into `
… …
`. When updating an existing app, keep its plugin ID and update the version and usage instructions as appropriate. Working with an AI coding agent? It reads `AGENTS.md` automatically; `docs/` holds the same rules for people. diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 09f97a23..55c64be1 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -14,6 +14,6 @@ 提交可直接运行的文件；如果需要构建，附上源码和构建说明。不要提交 `node_modules/`、密钥、真实会话记录、个人数据或运行缓存。截图和示例请使用合成数据或充分脱敏的数据。 -提交前在 MiniMax Code 中手动安装、打开并检查主要功能，在 PR 中写明测试环境和结果；未验证的部分如实说明。更新已有作品时，保留插件 ID，并按改动更新版本与使用说明。 +提交前在 MiniMax Code 中手动安装、打开并检查主要功能，在 PR 中写明测试环境和结果；未验证的部分如实说明。如果 PR 描述是 AI 写的，请自己写开头两三句，测试结果和未验证的部分保持可见，其余内容放进 `
… …
` 折叠起来。更新已有作品时，保留插件 ID，并按改动更新版本与使用说明。 使用 AI 编码助手时，它会自动读取 `AGENTS.md`；`docs/` 里是同一套规则的人类可读版本。 From b2547ce3c42a0f8039e8dc12fbe9b0be77698370 Mon Sep 17 00:00:00 2001 From: dazhi Date: Mon, 9 Nov 2026 16:21:35 +0800 Subject: [PATCH 2/2] docs: note the blank line after and align sentence counts GitHub renders Markdown inside
only after a blank line that follows ; the one-line example invited broken rendering. CONTRIBUTING now asks for one to three opener sentences, as AGENTS.md does. Assisted-by: Claude Opus 5.5 (OpenCode) --- AGENTS.md | 5 +++-- CONTRIBUTING.md | 2 +- CONTRIBUTING.zh-CN.md | 2 +- 3 files changed, 5 insertions(+), 4 deletions(-) diff --git a/AGENTS.md b/AGENTS.md index f7875add..992780c6 100644 --- a/AGENTS.md +++ b/AGENTS.md @@ -30,8 +30,9 @@ package at `plugins///`; the rest change the checks screenshot when the page looks different. Keep these visible below it: the tested environment and results, what you did not verify, each remaining `npm run check` warning with its reason, and any new access or higher minimum client version. Put the rest of a long description inside - `
Written by …
`. Ask the person you work for to - read and edit the opener before you submit. + `
Written by …
`, with a blank line after + ``; without it GitHub shows the Markdown inside as plain text. Ask the person you work + for to read and edit the opener before you submit. ## Hard rules diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cc1af979..872b1ca8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -14,6 +14,6 @@ The plugin directory name must match `name` in `.minimax-plugin/plugin.json`. ** Submit ready-to-run files. If the app requires a build step, include its source and build instructions. Do not commit `node_modules/`, credentials, real session records, personal data, or runtime caches. Use synthetic or thoroughly anonymized data in screenshots and examples. -Before submitting, install the app in MiniMax Code, open it, and check its main features. Include your test environment and results in the pull request, and state any unverified behavior. If an AI agent wrote the description, write its first two or three sentences yourself, keep the test results and unverified behavior visible, and fold the rest into `
… …
`. When updating an existing app, keep its plugin ID and update the version and usage instructions as appropriate. +Before submitting, install the app in MiniMax Code, open it, and check its main features. Include your test environment and results in the pull request, and state any unverified behavior. If an AI agent wrote the description, write its first one to three sentences yourself, keep the test results and unverified behavior visible, and fold the rest into `
… …
`, leaving a blank line after `` so the Markdown inside still renders. When updating an existing app, keep its plugin ID and update the version and usage instructions as appropriate. Working with an AI coding agent? It reads `AGENTS.md` automatically; `docs/` holds the same rules for people. diff --git a/CONTRIBUTING.zh-CN.md b/CONTRIBUTING.zh-CN.md index 55c64be1..be1bf509 100644 --- a/CONTRIBUTING.zh-CN.md +++ b/CONTRIBUTING.zh-CN.md @@ -14,6 +14,6 @@ 提交可直接运行的文件；如果需要构建，附上源码和构建说明。不要提交 `node_modules/`、密钥、真实会话记录、个人数据或运行缓存。截图和示例请使用合成数据或充分脱敏的数据。 -提交前在 MiniMax Code 中手动安装、打开并检查主要功能，在 PR 中写明测试环境和结果；未验证的部分如实说明。如果 PR 描述是 AI 写的，请自己写开头两三句，测试结果和未验证的部分保持可见，其余内容放进 `
… …
` 折叠起来。更新已有作品时，保留插件 ID，并按改动更新版本与使用说明。 +提交前在 MiniMax Code 中手动安装、打开并检查主要功能，在 PR 中写明测试环境和结果；未验证的部分如实说明。如果 PR 描述是 AI 写的，请自己写开头一到三句，测试结果和未验证的部分保持可见，其余内容放进 `
… …
` 折叠起来；`` 后要空一行，否则里面的 Markdown 不会渲染。更新已有作品时，保留插件 ID，并按改动更新版本与使用说明。 使用 AI 编码助手时，它会自动读取 `AGENTS.md`；`docs/` 里是同一套规则的人类可读版本。