使用GIT提出错误,错误或有问题的输出的方法



通常,我在与其他开发人员Git存储库一起工作时必须处理许多副作用(错误(。这些通常是由于我自己的系统设置。团队中的每个人都有不同的设置。

我希望能够准确地向其他开发人员展示我必须经历的内容来处理其代码错误,新安装等。这可以在此过程中使用屏幕截图,以及终端输出。希望它将有助于缩小这些问题。

包括终端/控制台输出并添加屏幕截图的正确方法是什么?

每个人都会犯错误。实际上,将工件施加到存储库中听起来并不是一个很好的政策,可以帮助您从这些错误中学习。

要解决您的主要问题,提交代码在某些机器而不是其他机器上起作用的问题,请考虑使用诸如Docker之类的容器环境。在您的存储库的顶级提供Dockerfile,该码头提供了必要的操作系统,支持库,语言库和适当版本的工件提供端到端环境。

每个开发人员都可以自定义自己的本地开发工具,但是归根结底,应该要求他们所做的任何工作都必须导致容器内的预期和纠正行为,并且对运行时环境,依赖项等的任何必要更改都反映在实际更改容器定义本身(例如DockerFile(并相应地更新任何测试的投入中。

现在,当某人查看您的存储库时,他们只需要docker build ...docker run ...(命令本身可以存储在shell脚本或构建工具中(,每个人都应该能够重现完全相同的构建伪像。

最好还是包括一些接受测试,这些测试将在某些情况下自动执行此操作,例如合并到一个特殊的分支,甚至在所有提交中,并在内置容器伪像的内部自动运行一组测试。

解决有关他人错误的副作用的一般问题,请考虑使用各种代码审查实践。

如果您的团队练习代码使用某种类型的git接口,例如使用github,则添加壳代码片段,粘贴的壳输出或其他示例或屏幕截图可能在代码审核设置中是适当的,例如拉动要求。这是最适合执行每个工作单元所唯一的错误的错误,例如编码错误,真正的错误或试图解决的解决方案的方面,该解决方案具有无关紧要的副作用。

如果某种错误会随着时间的流逝而持续存在,请考虑问题不仅在犯错的人的一边。相反,某些责任在于没有良好的集中文档或工具来始终如一地克服"陷阱"。

在这种情况下,您可以制作一个单独的团队存储库,称为"文档"或"开发人员workfflow"之类的东西,这旨在仅保留有关宣传文档的详细说明,详细说明了诸如重新订阅,提交挂钩,挂钩,挂钩,订婚,良好的习惯等。

它也可能包含示例代码,例如在git中配置预加压挂钩,或如何安装自定义的绒布工具,因此,对某些工具的专业知识较少的团队成员仍然可以轻松地从由良好的工具中受益。团队中经验丰富的成员。

这具有额外的好处,您可以在添加和更新良好工作流的说明和示例时使用代码审核过程本身。它使您可以建设性地解决问题,例如"这里有一些有用的演练和示例",而不是在错误中擦鼻子。

您不应使用项目分支进行交互。还有许多其他方法:IMS,问题跟踪器,Wiki,甚至电子邮件。

you 可以使用使用git作为运输的跟踪器(来自Google:1、2、3等 - 我实际上都没有尝试过(,但是我没有听说过任何成熟的足以实际使用它,它们应该在其他分支/存储库中。

最新更新