以正确的方式对您的代码库进行更改

高效的代码提交：避免未来问题的最佳实践

糟糕的代码提交会带来巨大的麻烦。你是否曾苦苦追寻某个特定更改的意图，或是当前代码的状态？正确的代码提交方式能有效避免这些难题。本文将深入探讨软件提交的最佳实践。

核心要点

• 正确的代码提交能防止混淆，节省未来时间。提交应具有原子性，一次只处理一个特定问题，而不是臃肿地影响大量文件并添加多个功能。
• 良好的提交应清晰、有见地且具有原子性。提交结构应包含类型或组件、清晰的主题以及可选的正文以提供更多上下文或细节。
• 应在提交信息中处理问题，使用关键词和问题 ID 号。这便于跟踪项目中的任务、改进和错误。
• 无论团队规模大小，正确的代码提交对良好的项目管理至关重要。它维护了代码库的完整性，使其他开发人员更容易理解和处理代码。

为什么要费心？

如果你已经将项目存储在 GitHub 上，你可能会认为文件是安全的，无论何时需要更新代码，你都可以提取更改，这就足够了。所有这些都可能是真的。但是，让我们看看通过付出更多努力可以避免哪些潜在问题，以及如果你这样做会获得哪些额外的好处。

团队合作或个人工作都应避免单打独斗

上述理由通常来自习惯于独自工作的开发人员。但当他们需要与其他人共享代码时，事情就会变得混乱，需要大量的解释。记住，我们的工作不仅仅是编写代码。我们还需要管理事情，这需要一定程度的组织性和方法论。虽然团队合作更容易暴露由组织不善造成的问题，但我们也可以从更好的方法中受益，即使是独自工作时也是如此。

原子提交与臃肿提交

我们都需要撤销一个小小的更改，却发现自己在一个巨大的提交中搜索它，这个提交更改了数十个文件并添加了多个功能。如果该更改位于仅处理该特定问题的单个提交中，那么回滚将容易得多。

混乱的、臃肿的方式

<code>git add *
git commit -m "new components"</code>

在这个例子中，我们可以肯定有很多文件受到了影响。此外，“new components”这个信息并没有告诉我们太多信息——例如哪些组件、这些组件的哪些功能，以及功能是新的还是重构。此外，是否解决了任何现有的错误？

当我们需要更改或恢复某些内容时，这些信息将非常重要。我们将试图在一堆干草中找到一根针，我们最终可能会查看代码库，并在调试时花费宝贵的时间。

原子方式

<code>git add *
git commit -m "new components"</code>

现在我们开始有所了解了，因为我们开始更清楚地了解那个提交发生了什么。

诀窍是，我们可以将更改作为工作流程的一部分半自动提交。也就是说，执行一个执行非常具体操作的工作块(实现特定功能、修复错误、优化算法)，进行测试(如果需要，编写单元测试)，在记忆新鲜时添加描述，然后立即提交。重复此过程。

良好提交的结构

这些规则并非一成不变，但可以帮助你评估良好的提交可能是什么样子：

• 清晰：对提交更改所做的工作没有疑问。
• 有见地：清楚地描述代码的功能，必要时提供链接或额外信息，并标记正在处理的错误或问题。
• 原子性：一次只处理一件事情(考虑一个“工作块”，可以是 20 分钟到 2 小时，如果是一个快速的错误修复，甚至可以是 2 分钟)。

让我们来看一个模板并将其分解：

<code>git add ui/login.html static/js/front-end.js
git commit -m "validate input fields for login"</code>

类型、组件或子系统

这将是一组可以组合在一起的软件项目功能。例如，AngularJS 中所谓的类型，或 SrummVM 中所谓的子系统。

（必填）主题

主题是一行简单直接的描述，说明提交所做的工作，以便每个人都能一目了然。

在主题格式方面，我通常遵循以下简单准则：

1. 使用祈使句(“change”而不是“changed”)
2. 不要大写第一个字母
3. 末尾不要加句点(.)
4. 如果有可选正文，则附加“(…)”

（可选）正文

有时，我们需要提供比主题行中适合的更多细节来提供上下文，例如修复持续存在的错误时，或破解算法时。

在这些情况下，你可以简单地输入双换行符(以便主题用作标题)，然后输入所需的信息。

不要忘记处理问题！

最后，还有一个处理问题的问题(双关语！)。任何体面的中大型软件开发项目都应该使用问题跟踪器来跟踪任务、改进和错误——无论是 Atlassian Jira、Bugzilla、GitHub 的问题跟踪器还是其他。

问题管理

如果你不知道，大多数系统都可以直接从提交信息中管理问题！

你可以：

• 关闭/解决问题
• 如果问题之前已关闭，则重新打开问题
• 如果功能被推迟到以后，则保留问题

只需要使用这些关键词和问题的 ID 号即可。

此外，你仍然可以引用问题作为提供上下文的方式，即使你不想修改其状态——例如，“参见 #12”。

所有这些引用都将对在跟踪器上打开该问题的任何人可见，这使得跟踪给定任务或错误的进度变得容易。

总结

你不会总是做得对(我个人也不是！)。事情会变得混乱，有时你不会遵循你为自己或你的团队设定的规则——这是流程的一部分。但希望你知道，只需对你的工作流程进行一些升级，你就可以做到井井有条，从长远来看，为你和你的团队节省时间。

我还从经验中得知，项目涉及十名开发人员还是完全由你处理，这几乎没有什么区别。简而言之，以正确的方式提交代码更改——这是良好项目管理的关键部分。

进一步阅读

• 使用 Git 历史记录讲述故事。Seb Jabocs 在 FutureLearn 上的一篇有趣的文章。
• Angular 的提交信息指南。即使你不使用 Angular，这也是一篇有益的阅读材料。
• FreeBSD 提交者指南。如果有一个的话，这是一个关于该主题的深入指南。
• 如何正确组织代码库中的文件并避免混乱。我们解释了如何为大型和小型项目组织文件，提供一些易于遵循的最佳实践。
• 快速入门 Git。本简明指南旨在帮助初学者在一个周末内快速掌握 Git。
• 专业 Git。Wiley 的这本书更进一步，为开发人员提供了他们需要成为 Git 大师的深入研究。

关于代码库和提交更改的常见问题解答 (FAQ)

• 代码库和源代码有什么区别？

代码库是指用于构建特定软件或应用程序的整个源代码集合。它包括所有版本的代码和分支。另一方面，源代码是当前正在处理的代码库的一部分。它是用编程语言编写的代码，然后编译成可执行程序。

• 代码库中的提交更改是如何工作的？

在代码库中提交更改涉及更改源代码，然后将这些更改保存到代码库。此过程通常在像 Git 这样的版本控制系统中完成。当你提交更改时，你实际上是在那个时间点拍摄你的工作快照。这允许你跟踪你所做的更改，并在必要时恢复到以前的版本。

• 以正确的方式提交更改的重要性是什么？

以正确的方式提交更改对于维护代码库的完整性至关重要。它确保代码库保持干净和易于管理，使其他开发人员更容易理解和处理代码。它还有助于跟踪更改并识别何时以及在何处将错误引入代码。

• 提交更改的一些最佳实践是什么？

提交更改的一些最佳实践包括进行小的、增量的提交，编写清晰且描述性的提交信息，以及在提交之前测试你的更改。定期将你的本地代码库与主代码库同步也很重要，以避免冲突。

• 什么是版本控制系统，它与代码库有什么关系？

版本控制系统是一种帮助管理代码库更改的工具。它在一个特殊类型的数据库中跟踪对代码的每一次修改。如果出现错误，开发人员可以倒回时间并比较代码的早期版本，以帮助修复错误，同时最大限度地减少对所有团队成员的影响。

• 如何避免提交更改时发生冲突？

可以通过定期将你的本地代码库与主代码库同步来避免冲突。这确保你始终在处理代码的最新版本。与你的团队沟通也很重要，确保每个人都知道正在进行的更改。

• 代码库在软件开发中的作用是什么？

代码库在软件开发中起着至关重要的作用。它作为所有源代码的中央存储库，允许开发人员协同工作并同时处理软件的不同部分。它还有助于跟踪更改并维护项目的历史记录。

• 代码库和代码存储库有什么区别？

代码库是指软件的整个源代码集合，而代码存储库是存储和管理此代码的地方。代码存储库可以包含多个代码库，通常由版本控制系统管理。

• 如何确保我的提交有意义且有用？

为了确保你的提交有意义且有用，重要的是要进行小的、增量的提交，每个提交都有其特定的目的。每个提交都应该代表一个单一的逻辑更改。编写清晰且描述性的提交信息也很重要，这些信息解释了所做的更改以及原因。

• 代码库和构建之间的关系是什么？

构建是将代码库中的源代码转换为可执行程序的过程。代码库作为构建过程的输入，输出是可以安装并在计算机上运行的软件产品。构建过程可以包括编译代码、链接库以及打包软件以进行分发。

以上是以正确的方式对您的代码库进行更改的详细内容。更多信息请关注PHP中文网其他相关文章！