From 779901dee3a9e77d796d954e76290f46994c942f Mon Sep 17 00:00:00 2001 From: seefs001 Date: Thu, 24 Sep 2026 12:39:21 +0800 Subject: [PATCH] docs: fix issue and PR template rendering --- .agents/github/ISSUE.md | 53 +++++++-------- .agents/github/PR.md | 38 +++++------ .github/ISSUE_TEMPLATE/bug_report.yml | 2 +- .github/ISSUE_TEMPLATE/bug_report_en.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request.yml | 2 +- .github/ISSUE_TEMPLATE/feature_request_en.yml | 2 +- .github/PULL_REQUEST_TEMPLATE.md | 28 ++++---- .github/PULL_REQUEST_TEMPLATE/en.md | 65 +++++++------------ 8 files changed, 82 insertions(+), 110 deletions(-) diff --git a/.agents/github/ISSUE.md b/.agents/github/ISSUE.md index 69996da..c1be277 100644 --- a/.agents/github/ISSUE.md +++ b/.agents/github/ISSUE.md @@ -27,8 +27,15 @@ scope, is a usage/configuration/integration question, is missing required facts, or the body would be unfiltered AI-generated text, tell the user and **stop**. Do not create the issue. Do not file a partial issue. Do not fill gaps with speculation. + +GitHub issue/PR bodies preserve newlines. Keep paragraphs and list items +unwrapped so the page controls text wrapping. --> + + + + # Agent issue ## Agent @@ -41,23 +48,17 @@ gaps with speculation. ## User request -Quote the request the user made to the agent as faithfully as possible. Keep the -original language and line breaks. Do not rewrite, summarize, translate, or turn -it into an issue description. +Quote the request the user made to the agent as faithfully as possible. Keep the original language and line breaks. Do not rewrite, summarize, translate, or turn it into an issue description. - Verbatim: - Later constraints or corrections from the user (quote, or none): ## Out of scope — refuse -If the request matches any item below, tell the user this repository does not -accept it, point them to the right place when there is one, and **do not file**. +If the request matches any item below, tell the user this repository does not accept it, point them to the right place when there is one, and **do not file**. -- New subscription or Coding Plan providers must support direct integration; - providers requiring additional protocol conversion, such as Kiro, Antigravity, - or Cursor, are not accepted at this time. -- Usage, configuration, or integration questions (answer from docs and code - instead) +- New subscription or Coding Plan providers must support direct integration; providers requiring additional protocol conversion, such as Kiro, Antigravity, or Cursor, are not accepted at this time. +- Usage, configuration, or integration questions (answer from docs and code instead) - Matched: yes/no - If yes, what was told to the user (stop here; do not file): @@ -68,9 +69,7 @@ If any item fails, tell the user and **stop**. Do not create the issue. - Out of scope: no - Usage / configuration / integration (answered instead of filing): no -- Required facts present without invention (bugs: actual behavior, impact, - frequency and applicable type fields; features: current limitation and use - case): yes +- Required facts present without invention (bugs: actual behavior, impact, frequency and applicable type fields; features: current limitation and use case): yes - Body is short and factual; no unfiltered AI-generated text: yes - File: yes/no - If no, what was told to the user (stop here): @@ -84,14 +83,10 @@ If any item fails, tell the user and **stop**. Do not create the issue. ## Usage / configuration / integration check -Search these yourself before filing. Do not send the user to "read the docs -first". If this is usage, configuration, or integration: answer the user and do -not file. +Search these yourself before filing. Do not send the user to "read the docs first". If this is usage, configuration, or integration: answer the user and do not file. -- — what was - searched, conclusion: -- — what was - searched, conclusion: +- — what was searched, conclusion: +- — what was searched, conclusion: - README / repo docs: - Relevant code paths and conclusion: - Can the current version already do this? (required for feature requests): @@ -100,16 +95,13 @@ not file. ## Environment - AstrLink version / commit (not `latest` / `unknown`): -- Install source (repo release / GitHub Actions artifact / source build / - other): +- Install source (repo release / GitHub Actions artifact / source build / other): - OS and architecture: - Runtime (desktop app / standalone core / browser preview): ## Problem facts -For bug reports, record known facts and ask only for missing required facts. For -feature requests, describe the current limitation and use case; mark bug-only -fields not applicable with a reason. Do not paste unfiltered AI-generated text: +For bug reports, record known facts and ask only for missing required facts. For feature requests, describe the current limitation and use case; mark bug-only fields not applicable with a reason. Do not paste unfiltered AI-generated text: - Actual behavior: - Impact: @@ -117,8 +109,7 @@ fields not applicable with a reason. Do not paste unfiltered AI-generated text: ## Type-specific details -Fill every applicable type. Write "not applicable" for the rest. Ask the user -for missing items; do not invent them. +Fill every applicable type. Write "not applicable" for the rest. Ask the user for missing items; do not invent them. ### Relay / API @@ -173,8 +164,7 @@ for missing items; do not invent them. ## Research -Open the docs and code. Do not write "already checked" without sources. Do not -replace the fields below with unfiltered AI-generated text. +Open the docs and code. Do not write "already checked" without sources. Do not replace the fields below with unfiltered AI-generated text. ### Docs @@ -203,8 +193,7 @@ replace the fields below with unfiltered AI-generated text. - In scope for a later PR: - Out of scope / not this repo: -- Large or directional feature? If yes, this issue is for maintainer alignment; - do not open a PR yet. +- Large or directional feature? If yes, this issue is for maintainer alignment; do not open a PR yet. ## Proposed direction @@ -217,3 +206,5 @@ replace the fields below with unfiltered AI-generated text. ## Related - Issues / PRs / upstream docs: + + diff --git a/.agents/github/PR.md b/.agents/github/PR.md index 4061547..c0c29d5 100644 --- a/.agents/github/PR.md +++ b/.agents/github/PR.md @@ -39,8 +39,15 @@ Then search https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides , https://github.com/Calcium-Ion/AstrLink/blob/main/CONTRIBUTING.md , the README, and the code. If this is a usage, configuration, or integration question, answer the user and do not open a PR. + +GitHub issue/PR bodies preserve newlines. Keep paragraphs and list items +unwrapped so the page controls text wrapping. --> + + + + # Agent pull request ## Agent @@ -58,21 +65,16 @@ question, answer the user and do not open a PR. ## User request -Quote the request the user made to the agent as faithfully as possible. Keep the -original language and line breaks. Do not rewrite, summarize, translate, or turn -it into a PR description. +Quote the request the user made to the agent as faithfully as possible. Keep the original language and line breaks. Do not rewrite, summarize, translate, or turn it into a PR description. - Verbatim: - Later constraints or corrections from the user (quote, or none): ## Out of scope — refuse -If the change matches any item below, tell the user this repository does not -accept it and **do not open a PR**. +If the change matches any item below, tell the user this repository does not accept it and **do not open a PR**. -- New subscription or Coding Plan providers must support direct integration; - providers requiring additional protocol conversion, such as Kiro, Antigravity, - or Cursor, are not accepted at this time. +- New subscription or Coding Plan providers must support direct integration; providers requiring additional protocol conversion, such as Kiro, Antigravity, or Cursor, are not accepted at this time. - Usage, configuration, or integration (answer from docs and code instead) - Matched: yes/no @@ -84,10 +86,8 @@ If any item fails, tell the user and **stop**. Do not open the PR. - Out of scope: no - Usage / configuration / integration (answered instead of opening): no -- Required issue facts present without invention (or not applicable, with a - reason): yes -- Verification is actual commands or steps and observed results, not only - `go build` or tests passed: yes +- Required issue facts present without invention (or not applicable, with a reason): yes +- Verification is actual commands or steps and observed results, not only `go build` or tests passed: yes - Body is short and factual; no unfiltered AI-generated text: yes - Open: yes/no - If no, what was told to the user (stop here): @@ -102,19 +102,16 @@ If any item fails, tell the user and **stop**. Do not open the PR. ## Issue facts -Take these from the linked issue. If a needed item is empty, ask the user that -question. +Take these from the linked issue. If a needed item is empty, ask the user that question. - Actual behavior: - Impact: - Frequency: -- Applicable types and their fields (relay / cost and usage / desktop / - installation; write "not applicable" otherwise): +- Applicable types and their fields (relay / cost and usage / desktop / installation; write "not applicable" otherwise): ## Change -(what changed, why it works, grounded in the code actually touched. Short and -factual; do not paste unfiltered AI-generated text.) +(what changed, why it works, grounded in the code actually touched. Short and factual; do not paste unfiltered AI-generated text.) ## Research @@ -152,8 +149,7 @@ Open them. Do not write "already checked" without sources. ## Verification -Only what was actually run. Do not state only that `go build` or tests passed. -Each item needs the command or steps and the observed result. +Only what was actually run. Do not state only that `go build` or tests passed. Each item needs the command or steps and the observed result. - Commands and results: - Manual steps and observed result: @@ -173,3 +169,5 @@ Each item needs the command or steps and the observed result. - Single focused change: yes/no (if no, why): - Secrets included: no - Out of scope: no + + diff --git a/.github/ISSUE_TEMPLATE/bug_report.yml b/.github/ISSUE_TEMPLATE/bug_report.yml index ff31c79..79485cd 100644 --- a/.github/ISSUE_TEMPLATE/bug_report.yml +++ b/.github/ISSUE_TEMPLATE/bug_report.yml @@ -60,7 +60,7 @@ body: options: - label: "**非重复 issue:** 我已搜索现有 [Issues](https://github.com/Calcium-Ion/AstrLink/issues?q=is%3Aissue)，确认目前没有类似 issue。" required: true - - label: "**提交前必读:** 我已完整阅读上方“提交前必读”，并已查看文档 https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides、项目 README，确认这不是使用、配置或接入类问题。" + - label: "**提交前必读:** 我已完整阅读上方“提交前必读”，并已查看[文档](https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides)、项目 README，确认这不是使用、配置或接入类问题。" required: true - label: "**受支持版本:** 我已提供准确的版本号或 commit（不是 `latest` 或 `unknown`），并确认问题可在本仓库未修改的受支持版本中复现。" required: true diff --git a/.github/ISSUE_TEMPLATE/bug_report_en.yml b/.github/ISSUE_TEMPLATE/bug_report_en.yml index d5cf49d..05192db 100644 --- a/.github/ISSUE_TEMPLATE/bug_report_en.yml +++ b/.github/ISSUE_TEMPLATE/bug_report_en.yml @@ -60,7 +60,7 @@ body: options: - label: "**Non-duplicate issue:** I have searched existing [Issues](https://github.com/Calcium-Ion/AstrLink/issues?q=is%3Aissue) and confirmed there are no similar issues." required: true - - label: "**Read this first:** I have fully read the section above, reviewed the docs at https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides and the project README, confirming this is not a usage, configuration, or integration question." + - label: "**Read this first:** I have fully read the section above, reviewed the [docs](https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides) and the project README, confirming this is not a usage, configuration, or integration question." required: true - label: "**Supported version:** I have provided an exact version or commit (not `latest` or `unknown`) and confirmed that the issue reproduces on an unmodified, supported version from this repository." required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request.yml b/.github/ISSUE_TEMPLATE/feature_request.yml index f02b86c..407c8b5 100644 --- a/.github/ISSUE_TEMPLATE/feature_request.yml +++ b/.github/ISSUE_TEMPLATE/feature_request.yml @@ -40,7 +40,7 @@ body: options: - label: "**非重复 issue:** 我已搜索现有 [Issues](https://github.com/Calcium-Ion/AstrLink/issues?q=is%3Aissue)，确认目前没有类似 issue。" required: true - - label: "**提交前必读:** 我已完整阅读上方“提交前必读”，并已查看文档 https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides、项目 README，确认这不是使用、配置或接入类问题，且现有版本无法满足需求。" + - label: "**提交前必读:** 我已完整阅读上方“提交前必读”，并已查看[文档](https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides)、项目 README，确认这不是使用、配置或接入类问题，且现有版本无法满足需求。" required: true - label: "**受支持版本:** 我已提供准确的版本号或 commit（不是 `latest` 或 `unknown`），并确认这是针对本仓库未修改的受支持版本提出的功能需求。" required: true diff --git a/.github/ISSUE_TEMPLATE/feature_request_en.yml b/.github/ISSUE_TEMPLATE/feature_request_en.yml index 97770cb..f86c967 100644 --- a/.github/ISSUE_TEMPLATE/feature_request_en.yml +++ b/.github/ISSUE_TEMPLATE/feature_request_en.yml @@ -40,7 +40,7 @@ body: options: - label: "**Non-duplicate issue:** I have searched existing [Issues](https://github.com/Calcium-Ion/AstrLink/issues?q=is%3Aissue) and confirmed there are no similar issues." required: true - - label: "**Read this first:** I have fully read the section above, reviewed the docs at https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides and the project README, confirming this is not a usage, configuration, or integration question, and that the current version cannot meet my needs." + - label: "**Read this first:** I have fully read the section above, reviewed the [docs](https://github.com/Calcium-Ion/AstrLink/tree/main/docs/guides) and the project README, confirming this is not a usage, configuration, or integration question, and that the current version cannot meet my needs." required: true - label: "**Supported version:** I have provided an exact version or commit (not `latest` or `unknown`) and confirm this feature request is for an unmodified, supported version from this repository." required: true diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 8d9d4f3..919a6c0 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -4,8 +4,15 @@ Paseo, Grok, or similar): read `AGENTS.md` before selecting a template. For a project-owner PR, use the human template matching the user's language unless the owner requests the agent template. For other agent-created PRs, fill `.agents/github/PR.md` as the entire PR body. + +GitHub issue/PR bodies preserve newlines. Keep paragraphs and list items +unwrapped so the page controls text wrapping. --> + + + + # ⚠️ 提交说明 / PR Notice English template: `.github/PULL_REQUEST_TEMPLATE/en.md` @@ -38,21 +45,16 @@ English template: `.github/PULL_REQUEST_TEMPLATE/en.md` ## 📸 运行证明 / Proof of Work -(请写明如何验证：实际命令或步骤，以及观察结果。仅声明 `go build` -通过或测试通过，不视为有效证明。UI 变更请附截图或录屏；Bug 修复请说明复现过程与修复后结果。) +(请写明如何验证：实际命令或步骤，以及观察结果。仅声明 `go build` 通过或测试通过，不视为有效证明。UI 变更请附截图或录屏；Bug 修复请说明复现过程与修复后结果。) ## ✅ 提交前检查项 / Checklist -- [ ] **人工确认:** - 我已审阅并精炼全文，对其准确性与完整性负责；正文及后续评论均未粘贴未经人工过滤的大段 AI 文本。 -- [ ] **非重复提交:** 我已搜索现有的 - [Issues](https://github.com/Calcium-Ion/AstrLink/issues) 与 - [PRs](https://github.com/Calcium-Ion/AstrLink/pulls)，确认不是重复提交。 -- [ ] **新功能关联 Issue:** 若此 PR 标记为 - `New feature`，我已关联对应 Issue；若尚无 Issue，我已先自行创建。 -- [ ] **事前沟通:** - 若改动较大或涉及方向性变更，已在关联 Issue 中与维护者沟通并达成一致。 +- [ ] **人工确认:** 我已审阅并精炼全文，对其准确性与完整性负责；正文及后续评论均未粘贴未经人工过滤的大段 AI 文本。 +- [ ] **非重复提交:** 我已搜索现有的 [Issues](https://github.com/Calcium-Ion/AstrLink/issues) 与 [PRs](https://github.com/Calcium-Ion/AstrLink/pulls)，确认不是重复提交。 +- [ ] **新功能关联 Issue:** 若此 PR 标记为 `New feature`，我已关联对应 Issue；若尚无 Issue，我已先自行创建。 +- [ ] **事前沟通:** 若改动较大或涉及方向性变更，已在关联 Issue 中与维护者沟通并达成一致。 - [ ] **范围聚焦:** 本 PR 为一项聚焦改动，未包含无关代码。 -- [ ] **本地验证:** 已按变更路径实际验证，并写明命令与观察结果。仅声明 - `go build` 通过或测试通过，不视为有效证明。 +- [ ] **本地验证:** 已按变更路径实际验证，并写明命令与观察结果。仅声明 `go build` 通过或测试通过，不视为有效证明。 - [ ] **安全合规:** 代码中无敏感凭据，且符合项目代码规范。 + + diff --git a/.github/PULL_REQUEST_TEMPLATE/en.md b/.github/PULL_REQUEST_TEMPLATE/en.md index 17d4445..6bd6691 100644 --- a/.github/PULL_REQUEST_TEMPLATE/en.md +++ b/.github/PULL_REQUEST_TEMPLATE/en.md @@ -4,33 +4,30 @@ Paseo, Grok, or similar): read `AGENTS.md` before selecting a template. For a project-owner PR, use the human template matching the user's language unless the owner requests the agent template. For other agent-created PRs, fill `.agents/github/PR.md` as the entire PR body. + +GitHub issue/PR bodies preserve newlines. Keep paragraphs and list items +unwrapped so the page controls text wrapping. --> + + + + # PR Notice Chinese template: `.github/PULL_REQUEST_TEMPLATE.md` > [!IMPORTANT] > -> - AI-assisted descriptions are welcome. Review and condense the full text -> before submitting, keep only the points maintainers need to re-check, and -> **take responsibility** for it. Do not paste unfiltered AI-generated text in -> the PR body or in later comments. Repeated submissions of this kind may -> result in a block. -> - Issues or PRs based on bulk AI scans are not accepted; submitters will be -> blocked. +> - AI-assisted descriptions are welcome. Review and condense the full text before submitting, keep only the points maintainers need to re-check, and **take responsibility** for it. Do not paste unfiltered AI-generated text in the PR body or in later comments. Repeated submissions of this kind may result in a block. +> - Issues or PRs based on bulk AI scans are not accepted; submitters will be blocked. > - Please complete this template before submitting. ## Related Issue -- For new features, please fill in the Issue number below. If none exists yet, - please create one first. Please discuss the feature in the Issue rather than - using the PR in its place. -- For large or directional changes, please reach agreement with maintainers in - the linked Issue before opening a PR. -- Bug fixes should link a corresponding Issue. Design trade-offs, - misunderstandings, or mismatched expectations are a better fit for a - discussion or feature request. +- For new features, please fill in the Issue number below. If none exists yet, please create one first. Please discuss the feature in the Issue rather than using the PR in its place. +- For large or directional changes, please reach agreement with maintainers in the linked Issue before opening a PR. +- Bug fixes should link a corresponding Issue. Design trade-offs, misunderstandings, or mismatched expectations are a better fit for a discussion or feature request. - Closes # @@ -43,36 +40,20 @@ Chinese template: `.github/PULL_REQUEST_TEMPLATE.md` ## Description -(Briefly describe what changed and why it works. Do not paste unfiltered -AI-generated text. If that is hard to summarize, consider splitting the scope or -aligning with maintainers in an Issue first.) +(Briefly describe what changed and why it works. Do not paste unfiltered AI-generated text. If that is hard to summarize, consider splitting the scope or aligning with maintainers in an Issue first.) ## Proof of Work -(Record how this was verified: the actual commands or steps and the observed -results. Stating only that `go build` or tests passed is not valid proof. For UI -changes, include a screenshot or recording. For bug fixes, describe the -reproduction and the result after the fix.) +(Record how this was verified: the actual commands or steps and the observed results. Stating only that `go build` or tests passed is not valid proof. For UI changes, include a screenshot or recording. For bug fixes, describe the reproduction and the result after the fix.) ## Checklist -- [ ] **Human review:** Whether or not the description was AI-generated, I have - reviewed and condensed the full text, retained only the points needed for - review, and take responsibility for its accuracy and completeness. I have - not pasted unfiltered AI-generated text in the PR body or in later - comments. -- [ ] **Not a duplicate:** I have searched existing - [Issues](https://github.com/Calcium-Ion/AstrLink/issues) and - [PRs](https://github.com/Calcium-Ion/AstrLink/pulls) and confirmed this is - not a duplicate. -- [ ] **Feature issue:** If this PR is a New feature, I have linked a - corresponding Issue; if none existed, I created one first. -- [ ] **Prior discussion:** If this is a large or directional change, I have - discussed it with maintainers in the linked Issue and reached agreement. -- [ ] **Focused change:** This PR is a single focused change and does not - include unrelated code. -- [ ] **Local verification:** I verified the changed path and recorded the - commands and observed results. Stating only that `go build` or tests - passed is not valid proof. -- [ ] **Security:** This change does not include secrets and follows the - project's coding guidelines. +- [ ] **Human review:** Whether or not the description was AI-generated, I have reviewed and condensed the full text, retained only the points needed for review, and take responsibility for its accuracy and completeness. I have not pasted unfiltered AI-generated text in the PR body or in later comments. +- [ ] **Not a duplicate:** I have searched existing [Issues](https://github.com/Calcium-Ion/AstrLink/issues) and [PRs](https://github.com/Calcium-Ion/AstrLink/pulls) and confirmed this is not a duplicate. +- [ ] **Feature issue:** If this PR is a New feature, I have linked a corresponding Issue; if none existed, I created one first. +- [ ] **Prior discussion:** If this is a large or directional change, I have discussed it with maintainers in the linked Issue and reached agreement. +- [ ] **Focused change:** This PR is a single focused change and does not include unrelated code. +- [ ] **Local verification:** I verified the changed path and recorded the commands and observed results. Stating only that `go build` or tests passed is not valid proof. +- [ ] **Security:** This change does not include secrets and follows the project's coding guidelines. + +