仓库说明

本仓库以 GitHub 为主仓，GitCode 为镜像。

• 主仓库地址：https://github.com/MS33834/autoship-cli
• GitCode 镜像：https://gitcode.com/badhope/autoship-cli

请直接在 GitHub 主仓 提交 Issue 和 Pull Request。GitCode 仅用于代码镜像，不处理 Issue/PR。

---

贡献指南

感谢你对 AutoShip-CLI 的关注！我们欢迎并鼓励社区贡献。

行为准则

参与本项目即表示你同意遵守我们的行为准则。

如何贡献

• 报告 bug：请使用 GitHub Issues，并附上复现步骤、环境信息与最小复现示例。
• 提出建议：通过 GitHub Discussions 分享你的想法。
• 提交代码：Fork 仓库，创建特性分支，提交 Pull Request。

开发环境

本项目使用 uv 管理依赖。

uv sync --all-extras --dev
uv run pytest

代码规范

• 使用 ruff 进行格式化和 lint。
• 使用 pyright 进行严格类型检查。
• 提交信息使用英文，遵循 Conventional Commits 规范。
• 新增功能必须包含测试，保持覆盖率不低于 85%。

提交 Pull Request

1. 确保所有检查通过：uv run ruff check src tests、uv run pyright、uv run pytest。
2. 运行安全扫描：uv run bandit -r src -ll。
3. 在 PR 描述中说明改动原因、影响范围与测试方式。
4. 等待维护者 review，必要时进行修改。

提交插件到 Registry

我们欢迎第三方插件！请按以下流程提交：

1. 使用 autoship-sdk 创建插件项目并发布到 PyPI。
2. 在 GitHub 上选择 Plugin Submission 模板创建 issue。
3. 维护者会根据以下清单审核：
4. 插件遵循 AutoShip hook spec，不执行未授权操作。
5. 包含 README、开源许可证和基本测试。
6. 名称不与现有插件冲突，符合 autoship-* 命名约定。
7. 请求 verified 时需提供 SHA256 校验和或 GPG 签名。
8. 审核通过后，插件会被加入 src/autoship/registry/plugins.json， 并自动出现在 Plugin Registry Web UI。

许可证

通过贡献代码，你同意所贡献的内容采用与项目一致的 MIT 许可证。