项目治理¶
本文说明 hsolve 由谁决策、怎样决策、维护者承诺什么,以及维护者离开时项目怎样延续。维护者名单见 MAINTAINERS.md,贡献流程见 CONTRIBUTING.md。
角色¶
| 角色 | 是谁 | 权限与职责 |
|---|---|---|
| 贡献者 | 提交过 Issue、PR、测试矩阵、验证报告或文档的任何人 | 提议与讨论;PR 经评审后合并 |
| 维护者 | MAINTAINERS.md 中列出的人 | 评审与合并、管理 Issue、发布版本;遵守下文的响应目标 |
| 领域审核人 | 由维护者邀请的数值线性代数或计算电磁学专家 | 评审完备性证书与数值正确性相关的改动;可以否决此类改动 |
| 项目负责人 | 当前为 @seuclkzsd | 维护者意见不一致且无法达成共识时做最终决定,并公开理由 |
成为维护者:在至少 3 个月内有 5 个以上被合并的实质性 PR,或持续参与评审;由一名维护者在 Issue 中提名, 7 天内没有其他维护者反对即生效。提名、批准与权限变更都记录在该 Issue 中。
决策规则¶
| 改动类型 | 合并条件 |
|---|---|
| 文档、测试、不改变数值结果的重构与性能优化 | CI 通过 + 一名维护者批准 |
用户可见的接口:命令行选项、config.json 的键、report.json 的字段、Python API |
先开 Issue 讨论至少 7 天;遵循语义化版本(见「发布」) |
| 完备性证书与数值正确性:惯性计数、证书窗口与切点、收缩重跑、随机排除检验的失败概率界、单精度计数规则、残差验收、问题类型判定 | 见下文三条,缺一不可 |
| 新增依赖 | 必须是开源许可证,并登记到 docs/DEPENDENCIES.md、THIRD_PARTY_NOTICES 与 NOTICE |
| 本文件与 MAINTAINERS.md | PR 公示至少 14 天,项目负责人批准 |
证书与正确性相关的改动:
- 必须附测试:一个在改动前失败、改动后通过的测试;如果改动不应改变行为,则附证明行为不变的测试。 测试优先使用有解析解或精确离散参考的问题。
- 必须评审:除作者以外,至少一名维护者或领域审核人批准。项目只有一名维护者期间,该维护者自己的此类
改动须在 Issue 中公示至少 7 天,并附独立评测器(
tools/eval)在全部测例上的回归结果(全部有效、没有 虚报成功),之后才能合并。 - 同步文档:设计文档中的约定与 docs/FORMATS.md 中的报告字段一起更新, 并写进 CHANGELOG。
性能与正确性声明:README、文档和发布说明中的数字必须来自入库的原始数据与生成表格的脚本,并写明测试条件 (硬件、核数、线程数、内存上限、版本、重复次数、取的统计量)。无法复现的数字不得出现在这些位置。
分歧:先在 Issue 中讨论、寻求共识。无法达成共识时由维护者按简单多数表决;平票,或只有一名维护者时,由项目 负责人决定,并在 Issue 中写明理由。
响应目标¶
| 事项 | 目标 |
|---|---|
| 新 Issue 的首次回应 | 7 天内 |
| PR 的首次评审 | 14 天内 |
| 安全报告的确认 | 3 个工作日内(SECURITY.md) |
| 行为准则举报的回应 | 7 天内(CODE_OF_CONDUCT.md) |
| 发布 | 有用户可见的变化时,每月至少一个次版本或补丁版本 |
这些目标的达成情况(Issue 与 PR 首次回应时间的中位数)在每季度末记录到 ROADMAP.md 的进度表中。
发布¶
- 版本号遵循语义化版本:不兼容的接口变化只出现在主版本中,并至少提前一个次版本 标记为弃用、写进 CHANGELOG;改变数值结果的修复在发布说明中单列。
- 发布前:CI 全部通过;
CMakeLists.txt的项目版本、CITATION.cff与CHANGELOG.md三处版本号一致。 - 每个版本打 tag
vX.Y.Z,GitHub Release 附可移植的二进制包与SHA256SUMS,发布说明来自 CHANGELOG。
继任¶
- 维护者连续 6 个月没有活动(提交、评审或 Issue 回复)时,须在 Issue 中声明状态:继续、暂停或退出。 被提醒后 30 天内仍未声明的,视为退出,其权限由其余维护者收回。
- 每位维护者在 MAINTAINERS.md 中指定一名继任联系人。项目负责人退出时,由其余维护者在 30 天内推选新的负责人;没有其余维护者时,由继任联系人接手仓库管理权限。
- 如果项目连续 12 个月没有任何维护者活动,任何人都可以依照 Apache-2.0 继续开发;仓库会在 README 中指向 社区认可的后继仓库。