贡献
StackRivet 是开放内核,欢迎贡献。本页讲变更如何被提案与落地。
| 领域 | 适合提交的内容 |
|---|---|
| 后端平台 | Java / Spring Boot 服务、权限、安全、代码生成、任务与 Asset Service |
| 管理端前端 | Vue 3 页面、易用性改进、路由接入与组件修复 |
| 官网与文档 | 公开文档、教程、示例、SEO/GEO 内容改进与文案修正 |
公开使用、贡献和工程规则以公开仓库与本站文档为准。
任何功能、破坏性变更或跨模块工作,都先开 issue 或 RFC,再开始较大改动。提案应包含:
- 为什么要做。
- 会改变哪些公开 API、schema、UI 或行为。
- 非目标,避免范围失控。
- 验证步骤:测试、截图、迁移检查或 API 调用。
已接受的提案应留下足够公开上下文,让外部贡献者能理解和评审改动。影响公开扩展点的架构决策,应记录在相关公开仓库或本站文档里。
非平凡改动必须满足公开仓库门禁:工程标准、贡献规则、测试与 CI。工程标准与 AI 护栏为人和 AI 工具总结同一套规则。
分支、PR、commit
Section titled “分支、PR、commit”- 分支:
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贡献检查清单
Section titled “贡献检查清单”- 文档改动放到受影响的文档页;代码改动放到对应代码仓,并在 PR 中链接相关 issue 或文档。
- 示例里使用仓库相对路径或公开 URL,避免出现本机路径、用户名、内网域名或只在个人环境可用的配置。
- 如果规则或示例已经过时,请补充原因、替代写法和验证步骤,让后续贡献者能复现同一条路径。
提一个 issue,附文件路径 + 章节、不一致或不清楚的点;能复现的问题请附最小复现步骤。
另见许可。