贡献与许可
2026/10/26大约 2 分钟
贡献与许可
许可
Atrman 基座与文档采用 MIT License。插件的许可由作者在各自 manifest.json 声明,可与基座不同。
环境
动手前先备好工具链:
| 项 | 要求 |
|---|---|
| PHP | ≥ 8.4 |
| MySQL | ≥ 8.0 |
| Redis | ≥ 5.0 |
| Node | ≥ 20.19 |
| pnpm | ≥ 8.8 |
后端 am-serve 用 Composer 装依赖,php windows.php(Win)或 php start.php start(*nix)起服务,默认监听 8787。前端 am-web 用 pnpm i + pnpm dev。
提交规范
仓库配了 husky + commitlint,沿用 Conventional Commits,type 只允许:
feat、fix、docs、style、refactor、perf、test、build、ci、revert、chore、wip。
格式:type(scope): subject,例如 feat(plugin): 支持存储适配器按 owner 反清。subject 大小写不校验。pre-commit 会跑 lint,不通过的提交会被拦下。
贡献流程
- 从主分支切特性分支,改动聚焦单一主题。
- 遵循开发规范:后端控制器/模型/验证器/时间字段/响应体口径,前端分层与页面约定,数据库命名与索引。
- 涉及扩展注册(事件、服务接管、适配器、任务、队列、鉴权)一律写进
Plugin.php::boot()并传owner,保证可反清、幂等。 - 提 PR 前对照提交前自检清单逐项过一遍。
- 文档改动与代码同 PR 提交,避免滞后;以代码为真源,发现文档与实现不符时以实现为准修订文档。
插件贡献
想在中心发布插件:按 manifest 规范组织目录、声明 support_version 与依赖、自带 composer.require(若有)、写好幂等的 install.sql/升级脚本。机制见插件结构 与安装升级。仅支持免费应用,仅支持源码交流学习。
反馈
问题与需求优先走仓库 Issue(见 am-serve/manifest.json 的 homepage)。提交时附最小复现、环境版本、相关日志。
