open-source-guide:18F的样式指南，用于开源项目文档-Open source

18F开源样式指南 本指南可帮助人们记录代码存储库，以使其易于使用和理解。 在每个部分中，我们概述了确保代码存储库清晰，可访问且用户友好的策略。 确保内部和外部读者都清楚我们的文档很重要。 随着团队的扩大，我们希望新员工能够轻松找到并使用我们现有的代码库。 如果我们想让外部贡献者感到欢迎或让外部组织分叉并使用我们的代码，这也非常重要。 （ ）解释项目是什么，为什么重要，以及人们如何提供帮助，可以确保人们可以分叉并适应我们的项目。 （Fork意味着将存在的代码复制到您自己的存储库或代码存储库中，以便您可以根据需要进行调整或使用。） 本指南还包含我们创建的清单，可帮助确保我们的存储库清晰，可访问且用户友好。 使用的某些术语可能特定于GitHub，但无论您使用的版本控制系统或平台如何，这些概念均适用。 我们编写它的目的是使非编码人员和编码人员都可以理解它。 （如果不清楚，请告知我们。）