建议动物

建议动物回答了我们运行cookiecutter之后的疑问，或者如何避免告诉人们我们支持运行一个sed脚本。

设计目标

例如cookiecutter等现有项目在初始项目生成方面做得相当不错，而例如ruff、fixit和pyupgrade等则提出了通用的（即适用于所有人的）改进建议。

建议动物的开发是为了服务于一个有看法的中心团队，但希望将建议的应用留给有兴趣和时间实施它们的各个仓库拥有者团队。

• 修复的存储与运行它们的实体的发布是解耦的。
  • 它只是一个git仓库，每次运行时都会被拉取。
  • 但如果您想用puppet或您的monorepo管理分发或在处理建议的更改，它也可以是一个目录。
• 修复是用一个简单的工作流程引擎运行的。
  • 使用git创建一个修复一个分支。
  • 昂贵的修复可以记录它们已完成，以避免再次运行
  • 修复可以是手动的（例如，“功能添加”）
  • 您可以为修复自定义工作流程，包括分支命名和要运行的命令（例如，您有FUSE/mercurial设置或需要运行tox -e stylefix并修改）。
• 您的用户可以选择他们想要的修复（通过质量=他们的可用时间）或拒绝一个修复。
• 第三方库在您的修复中很容易使用，甚至不需要是公开的。

修复置信度

使用交通灯颜色表示简洁性

• FixConfidence.GREEN 是高置信度修复，表示 a) 有问题存在，b) 这不会使问题变得更糟（例如，格式化）。相信你的测试并提交这些修复。

• FixConfidence.YELLOW 应该进行人工审核（并确保测试运行），但应用起来低效（例如，重命名包含大写字母的 Python 模块，或提升版本以避免已知的 CVE）。符合发布说明中提及通过标准。

• FixConfidence.RED 很可能需要人工接手并完成（例如：你显然使用了类型，你可能在 CI 中启用 mypy）。

版本兼容性

该库的使用应回溯到 3.7，但开发和 mypy 兼容性仅在 3.10-3.12 上进行。代码检查需要 3.12 才能完全兼容。

版本管理

该库遵循 meanver，基本上意味着 semver，并承诺在主版本变更时重命名。

许可

advice-animal 由 Tim Hatch 版权所有，并使用 MIT 许可证。有关详细信息，请参阅 LICENSE 文件。