-
Notifications
You must be signed in to change notification settings - Fork 4
docs: replace pull request template #36
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
+18
−24
Merged
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -1,37 +1,31 @@ | ||
| <!-- Localized instructions: English / 中文 --> | ||
|
|
||
| ## Summary / 概述 | ||
| <!-- | ||
| 提交前确认:不含 token、cookie、私有地址、下载内容或本地数据。 | ||
| Before submitting: no tokens, cookies, private URLs, downloads, or local data. | ||
| --> | ||
|
|
||
| <!-- | ||
| English: Describe the user problem and the change that addresses it. Link related issues with "Fixes #123" when applicable. | ||
| 中文:说明用户问题及解决该问题的改动。适用时使用 “Fixes #123” 关联 Issue。 | ||
| Closes #123 | ||
| --> | ||
|
|
||
| ## Scope and compatibility / 范围与兼容性 | ||
| ## 变更点 / Changes | ||
|
|
||
| <!-- | ||
| English: List affected CLI commands or flags, public Go SDK APIs, configuration, environment variables, output contracts, operator skill files, and release behavior. State "None" when there is no public impact. Do not claim MCP support: javdb-cli has no MCP server. | ||
| 中文:列出受影响的 CLI command 或 flag、public Go SDK API、配置、环境变量、输出契约、operator skill 文件和发布行为。没有公开影响时填写 “None”。javdb-cli 没有 MCP server,不要声称 MCP 支持。 | ||
| 列要点:改动 + 原因。关联 Issue 用 `Closes #123`(合并后关闭)。 | ||
| Bullet the change and why. Link an issue with `Closes #123` (closes on merge). | ||
| --> | ||
|
|
||
| ## Verification / 验证 | ||
| ## 验证步骤 / Verification | ||
|
|
||
| <!-- | ||
| English: List the exact commands you ran and their results. For real JavDB App API coverage, state whether it was run and use only redacted evidence. | ||
| 中文:列出实际运行的精确命令及结果。真实 JavDB App API 覆盖须说明是否运行,且只提供脱敏证据。 | ||
| 实际运行的命令和结果/截图。例如 / Commands and results/Screenshot. E.g. | ||
| - `go test ./...` | ||
| - `sh scripts/build.sh` | ||
| 未测试时说明原因。 / If not tested, explain why. | ||
| --> | ||
|
|
||
| ```text | ||
| go test ./... | ||
| sh scripts/build.sh | ||
| ``` | ||
|
|
||
| ## Checklist / 检查清单 | ||
| ## 检查清单 / Checklist | ||
|
|
||
| - [ ] The change is focused and linked to an issue when appropriate. / 改动目标明确,并在适用时关联 Issue。 | ||
| - [ ] I added or updated focused tests for changed behavior. / 我已为变更行为新增或更新聚焦测试。 | ||
| - [ ] I ran the relevant tests and recorded the results above. / 我已运行相关测试并在上方记录结果。 | ||
| - [ ] I updated the required CLI reference, SDK, README, maintainer, and operator-skill documentation. / 我已更新所需的 CLI reference、SDK、README、维护者和 operator-skill 文档。 | ||
| - [ ] I documented every new timeout, retry, pagination or result limit, truncation, fallback, or downgrade and its evidence. / 我已记录每项新增 timeout、retry、pagination 或结果限制、truncation、fallback 或 downgrade 及其证据。 | ||
| - [ ] I did not add passwords, JWTs, `~/.javdb-cli/auth.json` contents, proxy credentials, private URLs, local state, or private API responses. / 我没有添加密码、JWT、`~/.javdb-cli/auth.json` 内容、代理凭据、私有 URL、本地状态或私有 API 响应。 | ||
| - [ ] I updated migration guidance for every breaking change. / 我已为每个破坏性变更更新迁移指引。 | ||
| - [ ] 我没有引入恶意代码 / No malicious code | ||
| - [ ] 我没有新增依赖,或已在 `go.mod`(或 Rust `Cargo.toml`)的补充新的依赖 / No new dependencies, or added name, source, and purpose to `go.mod` (or Rust `Cargo.toml`) in Changes | ||
| - [ ] 这不是一次破坏性更新,或已在「变更点」标注迁移影响 / Not a breaking change, or migration impact noted in Changes | ||
| - [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/` | ||
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
issue: 此检查清单仅提到同步
docs/en/和docs/zh-CN/下的受影响文档,却遗漏了仓库特有的要求:当相关行为发生变化时,需要更新README、CLI 参考文档、SDK、维护者文档以及skills/javdb-cli文档。因此,CLI 或 SDK 的 PR 可能会在这些必需的公开文档或运维文档仍然过时的情况下合并。Triggers: 当 PR 更改 CLI 行为、标志、SDK API、身份验证、配置或运维指南时。
Suggested fix: 除了本地化同步要求之外,保留明确的 javdb-cli 文档检查清单,涵盖 README、CLI 参考文档、SDK、维护者文档和 operator-skill 文件。
Original comment in English
issue: The checklist only mentions synchronizing affected documents under
docs/en/anddocs/zh-CN/, and drops the repository-specific requirement to updateREADME, CLI reference, SDK, maintainer, andskills/javdb-clidocumentation when their behavior changes. A CLI or SDK PR can therefore merge with those required public or operator documents stale.Triggers: When a PR changes CLI behavior, flags, SDK APIs, authentication, configuration, or operator guidance.
Suggested fix: Retain the explicit javdb-cli documentation checklist covering README, CLI reference, SDK, maintainer, and operator-skill files, in addition to the locale synchronization requirement.