docs: replace pull request template - #36
Merged
Merged
Conversation
|
Important
This repository does not receive automatic reviews because it has fewer than 10 stars. ⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Plus Run ID: Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out. Comment |
github-actions
Bot
added
the
area: github-actions
审查者指南（小型 PR 中折叠显示）审查者指南此 PR 仅涉及文档：将仓库的拉取请求模板替换为 pixiv-cli 版本，修改贡献者提示和检查清单项目，不改变应用程序、发布或工作流的行为。 文件级变更
提示和命令与 Sourcery 交互
自定义你的使用体验访问你的仪表板以：
获取帮助Original review guide in EnglishReviewer's guide (collapsed on small PRs)Reviewer's GuideThis documentation-only PR replaces the repository’s pull request template with the pixiv-cli version, changing contributor prompts and checklist items without modifying application, release, or workflow behavior. File-Level Changes
Tips and commandsInteracting with Sourcery
Customizing Your ExperienceAccess your dashboard to:
Getting Help
|
![sourcery-ai[bot]](https://avatars.githubusercontent.com/in/48477?s=60&v=4){kind=small}
There was a problem hiding this comment.
嘿——我发现了 1 个问题
AI 代理提示
请处理本次代码审查中的评论：
## 个别评论
### 评论 1
<location path=".github/PULL_REQUEST_TEMPLATE.md" line_range="31" />
<code_context>
+- [ ] 我没有引入恶意代码 / 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/`
</code_context>
<issue_to_address>
**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 文件。
```suggestion
- [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/`
- [ ] `javdb-cli` 行为变更已同步更新 README、CLI reference、SDK、maintainer 与 `skills/javdb-cli` operator-skill 文档 / For `javdb-cli` behavior changes, README, CLI reference, SDK, maintainer, and `skills/javdb-cli` operator-skill documentation are updated
```
</issue_to_address>Sourcery 评估
等待批准。 请先处理 1 个发现的问题。
阻塞性发现：.github/PULL_REQUEST_TEMPLATE.md:31
请帮助我变得更有用！请在每条评论上点击 👍 或 👎，我会利用反馈来改进审查结果。
Original comment in English
Hey - I've found 1 issue
Prompt for AI Agents
Please address the comments from this code review:
## Individual Comments
### Comment 1
<location path=".github/PULL_REQUEST_TEMPLATE.md" line_range="31" />
<code_context>
+- [ ] 我没有引入恶意代码 / 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/`
</code_context>
<issue_to_address>
**issue:** The checklist only mentions synchronizing affected documents under `docs/en/` and `docs/zh-CN/`, and drops the repository-specific requirement to update `README`, CLI reference, SDK, maintainer, and `skills/javdb-cli` documentation 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.
```suggestion
- [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/`
- [ ] `javdb-cli` 行为变更已同步更新 README、CLI reference、SDK、maintainer 与 `skills/javdb-cli` operator-skill 文档 / For `javdb-cli` behavior changes, README, CLI reference, SDK, maintainer, and `skills/javdb-cli` operator-skill documentation are updated
```
</issue_to_address>Sourcery assessment
Approval pending. 1 finding to address first.
Blocking findings: .github/PULL_REQUEST_TEMPLATE.md:31
Help me be more useful! Please click 👍 or 👎 on each comment and I'll use the feedback to improve your reviews.
| - [ ] 我没有引入恶意代码 / 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/` |
There was a problem hiding this comment.
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 文件。
Suggested change
| - [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/` | |
| - [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/` | |
| - [ ] `javdb-cli` 行为变更已同步更新 README、CLI reference、SDK、maintainer 与 `skills/javdb-cli` operator-skill 文档 / For `javdb-cli` behavior changes, README, CLI reference, SDK, maintainer, and `skills/javdb-cli` operator-skill documentation are updated |
Original comment in English
issue: The checklist only mentions synchronizing affected documents under docs/en/ and docs/zh-CN/, and drops the repository-specific requirement to update README, CLI reference, SDK, maintainer, and skills/javdb-cli documentation 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.
Suggested change
| - [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/` | |
| - [ ] 受影响的文档已在 `docs/en/` 与 `docs/zh-CN/` 同步 / Affected docs synced under `docs/en/` and `docs/zh-CN/` | |
| - [ ] `javdb-cli` 行为变更已同步更新 README、CLI reference、SDK、maintainer 与 `skills/javdb-cli` operator-skill 文档 / For `javdb-cli` behavior changes, README, CLI reference, SDK, maintainer, and `skills/javdb-cli` operator-skill documentation are updated |
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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
变更点 / Changes
.github/PULL_REQUEST_TEMPLATE.md。javdb update、Release workflow 或发布脚本。验证步骤 / Verification
cmp -s：目标模板与 pixiv-cli 模板完全一致。git diff --check：通过。go test ./scripts/changescope：通过。go test ./internal/update/...：通过。sh scripts/test-workflows.sh：通过。sh scripts/test-package-release.sh：通过。sh scripts/test-clawhub-publish-workflow.sh：通过。go test ./...：通过。sh scripts/build.sh：通过。真实 JavDB App API：未运行，本次仅修改文档。
Sourcery 摘要
替换拉取请求模板，以提供更清晰的双语贡献指南和验证要求。
改进：
文档：
Original summary in English
Summary by Sourcery
Replace the pull request template to provide clearer bilingual contribution guidance and verification requirements.
Enhancements:
Documentation: