开发实践 development-practices

根据完成的定义工作(DoD) work-according-to-a-definition-of-done

每个团队对“完成”的含义都有不同的定义,但重要的是要有一个定义,并确保故事在被接受之前符合定义的标准。

团队通常指定的某些标准包括:

  • 已审查用于格式化的代码
  • 已添加Comments/Javadoc
  • 满足要求的测试覆盖率级别
  • 通过单元测试和集成测试
  • 已在QA环境中验证
  • 已实施本地化

如果没有一个明确定义的DoD,很容易出现许多事情已经完成了一半,没有任何真正完成的情况。

定义并遵守编码和格式惯例 define-and-adhere-to-coding-and-formatting-conventions

缩进级别和空格可能看起来并不重要,但具有正确格式化的代码在很大程度上提高了可读性和可维护性。 应将各种公约作为一个小组进行讨论和商定,然后在守则中加以遵循。

旨在实现高测试覆盖率 aim-for-high-test-coverage

随着项目实施规模的增长,测试所需的时间也会随之增长。 如果没有良好的测试覆盖率,测试团队就无法进行扩展,开发人员最终会被漏洞所淹没。

开发人员应该实践测试驱动开发(TDD),在满足其要求的生产代码之前编写失败的单元测试。 QA应创建一个自动化的验收测试集,以确保系统从高级别起按预期工作。

提供了一些自定义框架(如Jackalope和Prosper),可以更轻松地模拟JCR API,以确保开发人员在编写单元测试时的工作效率。

保持演示就绪 stay-demo-ready

系统应在每次迭代结束时向企业演示。 通过保持系统处于演示就绪状态,团队将始终处于生产就绪的迭代中,并且可以将技术债务保持在一个可维护的水平。

实施持续集成环境并使用它 implement-a-continuous-integration-environment-and-use-it

通过实施持续集成环境,您可以轻松且重复地运行单元测试和集成测试。 它还会将部署与开发团队分离,使团队的其他部分更高效,并实现更稳定和可预测的部署。

通过缩短构建时间来保持快速开发周期 keep-the-development-cycle-fast-by-keeping-build-times-low

如果单元测试需要很长时间才能运行,则开发人员将避免运行单元测试,从而失去其价值。 如果构建和部署代码需要很长时间,那么人们会减少此类操作的次数。 将缩短构建时间作为首要任务可以确保您在测试覆盖率和CI基础架构方面投入的时间能够继续提高团队的工作效率。

微调Sonar和其他静态代码分析工具并对其报告执行操作 fine-tune-sonar-and-other-static-code-analysis-tools-and-act-on-their-reports

代码分析工具可能很有价值,但前提是其报告需要开发团队采取行动。 如果不对这些工具提供的分析进行微调,它们生成的建议就会变得无关紧要,从而失去其价值。

遵守男孩Scout规则 follow-the-boy-scout-rule

“男孩Scout”有条规矩:“把它留得比你发现得好。” 只要开发团队的所有成员都遵守此规则,并在遇到问题时进行清理,代码就会不断改进。

避免实施YAGNI功能 avoid-implementing-yagni-features

YAGNI(您不需要它)功能是我们预计将来会需要某些内容(即使我们现在不需要这些内容)时所实施的功能。 理想情况下,我们应实施目前最简单的工作并使用连续重构来确保系统架构随时间推移而不断变化。 这使我们能够专注于重要的内容,并防止代码膨胀和特征蠕变。

recommendation-more-help
19ffd973-7af2-44d0-84b5-d547b0dffee2