跳转到内容

贡献

StackRivet 是开放内核,欢迎贡献。本页讲变更如何被提案与落地。

仓库包含
stackrivet-server后端(Java / Spring Boot)
stackrivet-admin-ui管理端前端(Vue 3)
stackrivet-site官网与公开文档

代码在代码仓;公开使用、贡献和工程规则在代码仓与本站文档中。

任何功能、breaking change 或跨模块工作,都先开 issue 或 RFC,再写大补丁。提案应包含:

  • 为什么要做。
  • 会改变哪些公开 API、schema、UI 或行为。
  • 非目标,避免范围失控。
  • 验证步骤:测试、截图、迁移检查或 API 调用。

已接受的提案应留下足够公开上下文,让外部贡献者能理解和评审改动。影响公开扩展点的架构决策,应记录在相关公开仓库或本站文档里。

非平凡改动必须满足公开仓库门禁:工程标准、贡献规则、测试与 CI。工程标准AI 护栏为人和 AI 工具总结同一套规则。

  • 分支feature/<slug>fix/<slug>docs/<slug>chore/<slug>。寿命 ≤ 3 天。
  • PR ≤ 500 行。更大的工作拆开(如”结构重排” + “内容重写”)。
  • commit 遵循 Conventional Commits,带可复现的 Verified: 行:
feat(<scope>): <祈使句主题 ≤ 70 字符>
- 改了什么
- 关联哪个 issue/RFC(若有)
Verified:
- mvn verify → 0 failures
- pnpm build → exit 0
  • 公开文档放在 stackrivet-site,代码相关指南放在对应代码仓。
  • 别引用绝对机器路径——用仓相对或同级仓路径,使其跨机器可复现。
  • 别为了让补丁更容易而删除公开规则;如果规则本身错了,更新规则并说明原因。

提一个 issue,附文件路径 + 章节、不一致或不清楚的点;能复现的问题请附最小复现步骤。

另见许可