Skip to content

armgit / peach

Public Imported from GitHub
0

Peach: Local-first video metadata scraper and media manager.

docs(contributing): issue 一律按模板写,命令行与 AI 工具提交时给出具体做法

longmeidaob3ea91c3bbbb
diff --git a/AGENTS.md b/AGENTS.md
index 0d825340f..2b4e55eac 100644
--- a/AGENTS.md
+++ b/AGENTS.md
@@ -11,6 +11,7 @@
- 代码判据确定、能按来源整批撤回的断言按 ADR-0052 落库;LLM 输出、打分、冲突与多候选只产生候选,不得自行标为 `approved`。真实写入执行 `peach-ledger-write`。
- 编辑前核对 `git status`。代码任务使用 `scripts/agent_worktree.py create` 的隔离工作树,主检出负责集成;先读 `peach-worktree`。
- 代码改动经 PR 交付,维护者自身也适用;issue 范围与交付流程见 `peach-issue-delivery`。
+- 替他人开 issue 按 `CONTRIBUTING.md`「开 Issue」:用 `.github/ISSUE_TEMPLATE/` 的模板章节和 `gh issue create --type`,写通用技术说法;本文件的术语与交付格式只用于改代码。
- 服务、端口或重启操作先核对监听与进程归属。已提交且测试通过的适用代码用 `restart_windows_tray.py` 重启并核验;手动或 CLI 发起的主任务仍在跑时先问,其余任务均能续跑时直接重启。
- `agent_worktree.py prune --apply` 可回收入口判定安全的工作树;只按 PID 清理本任务创建的进程,保护活动工作树、忽略文件与其他任务。
diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md
index 8ae7eaca8..00a3daa5d 100644
--- a/CONTRIBUTING.md
+++ b/CONTRIBUTING.md
@@ -1,6 +1,6 @@
# 参与 Peach
-Issues and pull requests are welcome. Maintainer-authored changes follow the same PR workflow. Small fixes (bugs, copy, documentation, tests) can go straight to a PR; complex bugs and large changes — new features, default behavior, connectors, contract or data-layer changes, anything an ADR covers — should have an issue first. Read [`AGENTS.md`](AGENTS.md) before opening a PR: it is the single entry point for development rules, and reviews follow it. Each platform has exactly one test entry point: `& .\scripts\test.ps1` on Windows and `./scripts/test.sh` on macOS/Linux. By submitting a contribution you agree to license it under AGPL-3.0-or-later. The rest of this document is in Chinese.
+Issues and pull requests are welcome. Maintainer-authored changes follow the same PR workflow. Small fixes (bugs, copy, documentation, tests) can go straight to a PR; complex bugs and large changes — new features, default behavior, connectors, contract or data-layer changes, anything an ADR covers — should have an issue first. Read [`AGENTS.md`](AGENTS.md) before opening a PR: it is the single entry point for development rules, and reviews follow it. Issues follow the templates in [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/); the terms and delivery format in `AGENTS.md` are for code changes only. Each platform has exactly one test entry point: `& .\scripts\test.ps1` on Windows and `./scripts/test.sh` on macOS/Linux. By submitting a contribution you agree to license it under AGPL-3.0-or-later. The rest of this document is in Chinese.
Peach 是单人自托管应用,由一个人维护。欢迎提 Issue 和 PR。维护者自己的改动也遵循同一套流程,通过 PR 保留审阅与验证记录。
@@ -11,6 +11,16 @@ Peach 是单人自托管应用,由一个人维护。欢迎提 Issue 和 PR。
## 开 Issue
+Issue 按 [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/) 的模板写:缺陷用 `bug_report.md`,建议用 `feature_request.md`。保留模板的章节标题和顺序,逐节填写;可选章节没有内容可以删掉,原因分析等额外信息放在模板章节之后。从网页「New issue」选模板最省事。用 AI 工具或命令行提交时,复制模板文件,去掉开头的 `---` 信息块和 `<!-- -->` 注释,填好后提交:
+
+```text
+gh issue create --repo peach-mitao/peach --title "<标题>" --type Bug --body-file <填好的模板>
+```
+
+建议把 `Bug` 换成 `Feature`;没有设置类型的权限时省略 `--type`,由维护者补上。正文写给维护者和其他用户看,用通用技术说法;`AGENTS.md` 与技能里的术语和交付格式只用于改代码,不用于 issue。
+
+Write issues with the templates in [`.github/ISSUE_TEMPLATE/`](.github/ISSUE_TEMPLATE/): `bug_report.md` for bugs, `feature_request.md` for features. Keep the template headings in order and fill in each one; drop optional sections you have nothing for, and put extra material such as a root-cause analysis after the template sections. The web form under New issue is the easiest path. When an AI tool or the command line submits the issue, copy the template file, remove the leading `---` block and the `<!-- -->` comments, fill it in, and submit it with the command above; use `--type Feature` for features, and leave out `--type` if you lack permission to set it. Write for maintainers and other users in plain technical language; the terms and delivery format in `AGENTS.md` and the skills are for code changes, not issues.
+
公开截图、录屏和附件使用不含露骨画面的演示资料,并遮盖隐私信息;不要上传影片、封面原图或数据库。公开内容与素材许可要求见[文档规范](docs/WRITING.md#公开与私有记录)。
Use demo data without sexually explicit imagery in public screenshots, recordings and attachments. Redact private information, and do not upload videos, original cover images or databases.