5修订控制最佳实践

每个嵌入式软件开发人员都应使用版本控制系统。我什至无法开始量化在整个职业生涯中使用此类系统节省的时间。当某些东西坏了,并且无法撤消时,回滚到以前版本的功能可以节省生命。即使开发人员认识并使用了修订控制系统,也应该使用几种最佳实践,以确保充分利用其修订控制系统。

最佳实践1-排除Debug文件夹

debug文件夹包含由编译器为源项目生成的所有目标文件,二进制文件和可执行文件。尽管团队可能想要保存这些文件的发行版本,但将它们保留在版本控制系统中有几个缺点:
•对象和可执行文件往往很大,并且可以很快用完版本控制系统中的大量空间
•签出修订版时,开发人员应使用自己的工具链进行构建,而不要依赖可能在不同条件下编译的文件
•执行软件时,未更改的文件可能处于不同的状态并导致意外的行为
由于这些原因及其他原因,开发人员应避免将调试文件夹及其内容保存在版本控制系统中。

最佳实践2 –使用“忽略”功能

大多数修订控制系统(例如git或mercurial)都具有忽略某些文件和文件类型的能力。使用此功能的一种好方法是为存储库系统应忽略而不添加到存储库中的对象,可执行文件和其他文件创建忽略条目。关于如何忽略文件类型的确切方法因一个版本控制系统而异。最好的方法是查阅用户手册。

最佳实践3 –提交详细的提交日志

我最大的烦恼之一是,当开发人员将代码提交到存储库中时,要么不加注释,要么不加注释,以致于无法确定代码库中的实际更改。拥有有关代码和更改内容的详细列表对于能够回滚并在需要时查找以前的版本至关重要。无数次软件中断,开发人员需要查看日志并确定何时添加或修改该功能。没有详细的日志,此过程将成为一个耗时的噩梦。每个日志中都应包含一些关键信息:
•软件版本号
•在软件中添加了什么以及在何处添加了
•在软件中修改了哪些内容以及受影响的模块
•包含软件版本当前所有已知未解决问题的列表
•任何有益的一般性评论

最佳实践4 –经常同步

版本控制系统仅在使用它们的开发人员经常同步其软件库时才有用。数天或数周没有提交代码正在寻找灾难。如果开发人员没有足够频繁地进行最新更改,则可能会发生相同的问题。他们的软件可以快速脱离与其余代码库的同步。因此,开发人员需要确保经常进行同步。如果不这样做,他们可能会发现自己花费太多时间试图将其代码合并到master分支中。

最佳做法5 –标签/分支正式发布

如果有即将发布的代码库,请通过将其分支或标记为正式版本来分离该代码。将这些代码分开保存会使开发人员更轻松地返回并查找代码版本。标记或分支为正式发行版本的代码也不应以任何方式加以修改或修改,而应保留为原始副本。

结论

遵循以下几种最佳实践将有助于确保您不仅在使用版本控制系统,而且从该系统中获得最大收益。如果使用正确,修订控制系统可以节省时间和精力。这些最佳实践将有助于确保您从系统中获得最大收益。

2 thoughts 上 “5修订控制最佳实践”

发表评论

您的电子邮件地址不会被公开。 必需的地方已做标记 *

该网站使用Akismet减少垃圾邮件。 了解如何处理您的评论数据.