【问题标题】:Does tidying your code warrant an individual Git commit? [closed]整理代码是否需要单独的 Git 提交? [关闭]
【发布时间】:2016-05-18 15:49:33
【问题描述】:

已确定每个单独的 Git 提交应该是一个单个逻辑更改。还确定此生产过程通常是混乱的(请参阅sausage-making)并且不应隐藏 - Seth Robertson 提倡 "Commit often, perfect later"

我发现在某个时候,无论是在项目结束时还是在一系列相关提交结束时,我都需要整理我的代码,尤其是当我全神贯注于一个问题并快速工作时。 整洁我不是指影响程序实际运行的逻辑更改,而是指如下内容:

  • 澄清 cmets
  • 更改函数顺序以提高可读性
  • 更正缩进/空白
  • 删除像// console.log(variables)这样的旧测试

我的问题是:将这些“装饰性”更改保存在单独的单独提交中是最佳做法吗? (如果不是,它们应该如何提交?)

请注意,我不会就此邀请意见。肯定有既定的最佳实践;上面的文章强调enforcing standards,所以了解这些标准是什么很重要。

除了 Seth Robertson 的文章,我还阅读了以下现有问题,但在任何地方都找不到我的问题:

【问题讨论】:

  • 单独提交外观更改。它有助于稍后隔离问题,因为您通常可以在查找错误时跳过整个仅外观更改提交。
  • stackoverflow.com/a/19656336/6194839 我在浏览您的链接时发现了这一点,因为我同意应该有一个标准。以下是我想从该链接中强调的内容: ():
    将您的提交的 指定为装饰性的。跨度>
  • @BryceDrew 我明白你的意思。您的评论促使我找到其他有信誉的样式指南示例,这些示例列出了各种提交“类型”和提交消息的推荐前缀。例如github.com/atom/atom/blob/master/…(前缀“艺术:”用于样式更改)和udacity.github.io/git-styleguide(前缀“样式:”)。这往往表明存在样式更改的约定是有效的提交。我会添加这些参考资料作为答案,但不幸的是,这个问题被搁置了。

标签: git git-commit code-readability


【解决方案1】:

是的,外观更改应该是分开的。它们是与功能更改分开的逻辑更改。此外,还可以更轻松地查看功能更改。

【讨论】:

    猜你喜欢
    • 1970-01-01
    • 1970-01-01
    • 2022-01-21
    • 1970-01-01
    • 1970-01-01
    • 1970-01-01
    • 2013-01-21
    • 2012-10-09
    • 2021-06-14
    相关资源
    最近更新 更多