Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 6 additions & 2 deletions .github/pull_request_template.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,12 @@
**创建 PR 前,请删除本提示段。**

向本仓库推送工作分支后,请等待 SPLRAD Steward 自动创建或更新 PR;确认机器人故障且没有对应 PR 时,再手动补建。
有本仓库写权限并向非默认工作分支推送后,请等待 SPLRAD Steward 自动创建或更新 PR,首次创建为草稿。自动化仍在运行时请等待,状态不明时先核查;确认机器人故障、无法自动创建且没有对应 PR 后,再手动补建。

通过 fork 贡献时,请自行创建 PR。
通过 fork 贡献时,请从自己的 fork 向上游创建 PR,无需等待机器人代开。

草稿准备好后,在 PR 页面点击 GitHub 原生的 **Ready for review**:PR 作者或拥有目标仓库 Write 及以上权限的用户均可操作,适用于同仓和 fork PR。机器人创建的 PR 可由具备上述仓库权限的用户操作;fork PR 作者无需上游 Write 权限。Ready 仅表示提交审查,检查、批准和人工合并仍须分别完成。

Steward 后续可能重建其管理的 PR 标题和完整正文;需要保留的补充说明和验证证据请写入 PR 评论。

手动创建 PR 时,请填写下列内容并删除填写提示;不适用的栏目填写“无”。

Expand Down
8 changes: 7 additions & 1 deletion CONTRIBUTING.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@

提交改动前,先确认它确实适用于多个 SPLRAD 公开仓库。某个产品独有的规则、构建命令或用户文档,应放在对应产品仓库。

`.github/copilot-instructions.md` 由 Steward 生成和同步。需要修改其中的通用审查规则时,请先修改 [`splrad/steward`](https://github.com/splrad/steward) 中的来源配置,不要直接改生成文件。`.github/pull_request_template.md` 中的受管注释也必须保留。
公共审查规则由 [`splrad/steward` 的中央配置](https://github.com/splrad/steward/tree/main/config/review)维护,供组织 Copilot 指令和各仓 `AGENTS.md` 使用。请在中央规则中修改,并按该目录的发布与同步说明更新生成内容。`.github/pull_request_template.md` 中的受管注释必须保留。

提交前请检查:

Expand All @@ -14,3 +14,9 @@
- Pull Request 说明了改动为何应成为组织默认配置。

组织成员和外部贡献者都应通过 Pull Request 提交改动。提交后请等待维护者审查和适用的自动检查,不要直接修改 `main`。

有本仓库写权限时,向本仓库非默认工作分支推送后等待 Steward 自动创建或更新 PR,首次创建为草稿。没有对应 PR 时先检查自动化;仍在运行则等待,状态不明则先核查,确认机器人故障、无法自动创建且仍无对应 PR 后才手动补建。通过 fork 贡献时,从自己的 fork 向本仓库创建 PR,无需等待机器人代开。

草稿准备好后,在 PR 页面点击 **Ready for review**。PR 作者或拥有目标仓库 Write 及以上权限的用户均可操作,适用于同仓和 fork PR。机器人创建的 PR 可由具备上述仓库权限的用户操作;fork PR 作者无需上游 Write 权限。Ready 仅表示提交审查,检查、批准和人工合并仍须分别完成。

手动创建时填写标题和变更说明,保留模板受管标记。Steward 后续可能重建其管理的 PR 标题和完整正文;需要保留的补充说明和验证证据请写入 PR 评论。
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,8 +7,8 @@
```text
.
├── .github/
│ ├── copilot-instructions.md Copilot 代码审查的中文输出与结论格式
│ └── pull_request_template.md 组织默认拉取请求模板
├── AGENTS.md 中央生成的共享规则与本仓库规则
├── CODE_OF_CONDUCT.md 组织公共行为准则
├── CONTRIBUTING.md 本仓库的贡献说明
├── LICENSE Apache License 2.0
Expand All @@ -17,7 +17,7 @@

### 拉取请求模板

`.github/pull_request_template.md` 是创建 PR 页面使用的组织默认模板,说明自动创建、故障补建和 fork 贡献的流程。Steward 后续更新会重新生成标题和正文;需要保留的补充信息请写在 PR 评论中。
`.github/pull_request_template.md` 是创建 PR 页面使用的组织默认模板,说明同仓自动创建、故障补建、fork 自建和原生 Ready 操作。Steward 后续可能重建其管理的 PR 标题和完整正文;需要保留的补充信息请写在 PR 评论中。

项目确有不同需求时,可以在项目仓库内提供自己的模板;否则应沿用这里的通用版本,避免重复维护。

Expand All @@ -29,9 +29,9 @@

### Copilot 代码审查说明

`AGENTS.md` 保存共享规则,`.github/copilot-instructions.md` 保存 Copilot 平台补充说明。两个文件均由 Steward 的中央规则生成和同步。
组织 Copilot 指令采用中央公共规则;本仓库的 `AGENTS.md` 由同一来源生成,保留共享规则和本仓库专用规则。

需要调整通用规则时,应修改 `splrad/steward` 中的 [`config/review/rules.json`](https://github.com/splrad/steward/blob/main/config/review/rules.json)。中央规则合并并成功部署后,由同步工作流更新受管仓库中的生成文件。规则尚未生效时,生成文件保持与当前中央策略一致。
需要调整通用规则时,应修改 `splrad/steward` 中的 [`config/review/rules.json`](https://github.com/splrad/steward/blob/main/config/review/rules.json),并按[发布与同步说明](https://github.com/splrad/steward/blob/main/config/review/README.md)先更新并验证组织指令,再更新采用摘要。中央规则合并部署后,由同步工作流更新各仓生成文件。规则尚未生效时,生成文件保持与当前中央策略一致。

## 与 Steward 的分工

Expand Down
Loading