View a markdown version of this page

基于 Git 的开发的最佳实践 - AWS 规范性指导

本文属于机器翻译版本。若本译文内容与英语原文存在差异,则一律以英文原文为准。

基于 Git 的开发的最佳实践

要成功采用基于 Git 的开发,必须遵循一套最佳实践,以促进协作、维护代码质量并支持持续集成和持续交付 (CI/CD)。除了本指南中的最佳实践外,还请查看《Well-Architect AWS ed 指南》 DevOps 。以下是基于 Git 的开发的一些关键最佳实践: AWS

  • 保持少量和频繁的更改 — 鼓励开发人员提交较小的增量更改或功能。这样可以降低合并冲突的风险,并且可以更轻松地快速识别和修复问题。

  • 使用功能切换-要管理不完整或实验性功能的发布,请使用功能切换或功能标志。这可以帮助您在生产环境中隐藏、启用或禁用特定功能,而不会影响主分支的稳定性。

  • 维护强大的测试套件 — 全面、维护良好的测试套件对于及早发现问题并验证代码库是否保持稳定至关重要。投资于测试自动化,并优先修复任何失败的测试。

  • 采用持续集成 — 使用持续集成工具和实践自动构建、测试代码变更并将其集成到develop分支(Gitflow)或分支(Trunk 或 main Fl GitHub ow)中。这可以帮助您尽早发现问题并简化开发过程。

  • 执行代码审查 — 鼓励对代码进行同行评审,以保持质量、共享知识并捕捉潜在问题,然后再将其整合到分main支中。使用拉取请求或其他代码审查工具来简化此过程。

  • 监控并修复损坏的构建-当构建中断或测试失败时,请优先尽快修复问题。这样可以使develop分支(Gitflow)或main分支(Trunk 或 GitHub Flow)保持可释放状态,并最大限度地减少对其他开发者的影响。

  • 沟通和协作-促进团队成员之间的开放式沟通和协作。确保开发人员知道正在进行的工作和对代码库所做的更改。

  • 持续重构 — 定期重构代码库以提高其可维护性并减少技术债务。鼓励开发人员让代码保持比他们发现的更好的状态。

  • 使用短期分支执行复杂任务-对于较大或更复杂的任务,请使用短期分支(也称为任务分支)来处理更改。但是,请务必缩短分支寿命,通常少于一天。尽快将更改合并回分develop支(Gitflow)或main分支(Trunk 或 GitHub Flow)。对于团队来说,规模更小、更频繁的合并和审阅比一个大型合并请求更容易使用和处理。

  • 培训和支持团队 — 为刚接触基于 Git 的开发或在采用基于 Git 的最佳实践方面需要指导的开发人员提供培训和支持。