发布时间：2021年8月24日 - 2分钟阅读
编写一个好的代码样本是很难的。让我澄清一下，编写一个演示API使用的样本，或者展示一个UI习语，可以是快速而简单的。困难来自于你需要添加到你的资源库的额外部分，以保持代码样本的新鲜和对你的开发人员的吸引力。
在代码中添加的第一件事是一个好的README，它的开头是一个摘要，说明为什么开发人员应该投入时间和精力来研究和理解这个样本。接下来是使用说明，以及指向问题跟踪器的链接，在那里开发者可以提出bug，并在某些事情令人困惑时要求澄清，这是一个很好的下一步。
接下来是代码本身。代码是否遵循布局和使用的惯例？这可能很简单，就像代码的位置一样，也可能很复杂，就像适当地设置铸币机之类的。我喜欢那些在代码格式化、布局、和提示规则集方面采用了强大标准的编程社区语言。这些标准为代码的外观和感觉带来了一致性，使其更容易被浏览。为了强制执行Dart和Flutter的代码格式，您可以在您的CI管道中添加以下命令，如果代码格式不正确，则构建失败。
$ dart format --output none --set-exit-if-changed .
在代码格式化之后，下一步是强制执行一套好的行文。对于Dart，我强烈建议研究lints包，对于Flutter，我同样建议研究flutter_lints包。为了确保lints在CI管道中通过，添加以下命令。
$ dart analyze
测试。哦，这么多的测试。单元测试、集成测试，对于Flutter，我们还有Widget测试。测试对样本来说是很好的，因为测试传达了一段代码打算如何使用的意图。当与上述的CI管道结合使用时，测试也能保持代码库的常青。了解更多关于Flutter测试能力的好地方是如何测试Flutter应用程序的代码实验室。分别为Dart和Flutter的CI命令。
$ flutter test # for Flutter projects
$ dart test # for pure Dart projects
如果您的代码库托管在GitHub上，那么我建议您如果有Dart项目，就使用Dart设置动作，如果有Flutter项目，就使用Flutter动作。为了获得额外的分数，可以考虑添加Very Good Coverage动作，以保持测试覆盖率高。鉴于你已经走到这一步，你也许应该用工作流状态徽章来宣传你的CI状态。
希望以上的补充列表能指导你使你的代码样本对你的目标受众更有价值。
