如何编写踢屁股拉请求

适量亵渎的Git入门指南

通过Akash Shah

对于新手开发人员(至少,那些想与其他人一起从事项目工作的人),编写提交和请求请求是必不可少的。 如果有效完成,它们最终将节省时间和精力,不仅对您有利,对您团队中的其他开发人员,项目经理和客户也是如此。

在进入美好的提交和拉取请求世界之前,退后一步来了解应用程序实际上是有帮助的

无需再费周折:

应用程序是功能的集合,这些功能可以共同帮助用户实现目标,无论是寻找新的住宿地点,与朋友联系还是浪费时间。

功能虽然差异很大,但具有一些特征:

  • 每个功能都有一个单独的功能。
  • 每个功能可以独立运行,也可以相互依赖。
  • 每个功能都包括帮助其接收信息,解析信息然后进行传递的代码。
  • 在大多数情况下,该代码仍然是单独的,其他功能无法访问。

文档作者,我们可以快点了吗? 我想做个很烂的狗屎!

嘘,年轻的Padewan。 我们到了那里。

现在,为什么我们要经历有关功能的整个讨论?

好吧,无论何时使用新功能或修复现有功能,都可以创建一个单独的分支,并将相关代码提交到该分支。 完成后,您将提交拉取请求 。 注意不要在一个分支中使用多个功能或修复。

提交

开发功能时,无需从一开始就构建其最终迭代。 您逐步构建它。 您可以从简单地激活功能开始,然后提供信息,依此类推,直到功能完成。

但是,您如何决定提交什么和何时提交?

这很简单。 提交步骤!

提交这些步骤可以使不熟悉您的代码的人轻松了解您的操作以及操作方式。

您可以做一些其他的事情来使您的提交变得更好:

  • 说明 应该用一句话形容您的所作所为。 如果您需要更多,也许您应该拆分提交。
  • 摘要应该描述提交的目标。 你想做什么? 将数据转换成字符串? 重构什么? 修复您之前弄糟的东西? (嘿,狗屎发生了。我没有判断!)
  • 不要害怕经常犯错! 您做得越多,您就会学到更多。
  • 确保您没有对Master做出任何承诺,除非您的项目负责人给予了此荣誉。
  • 温馨提示:除非您喜欢使项目负责人的头部爆炸,否则请尽量不要使用空格。

哇,文档作者,您刚刚在使用gif时获得了一些严肃的信誉!

谢谢读者。 我努力 现在开始请求。

拉取请求

拉取请求用于准备好审查代码的情况。 如果一切正常,您的项目负责人会将其合并到Master Branch中

现在,在变得头晕目眩并思考是时候提交PR之前,请退后一步,问自己以下问题:

  • 您是否删除了任何评论“他妈的,我为什么决定这样做?”
  • 您是否删除了任何未使用或不必要的代码? 即打印语句。
  • 没有其他重构的机会了吗?
  • 您的代码容易理解吗?

如果对以上所有问题的回答为是,请执行以下操作:

  • 测试以确保您的代码按预期工作并且没有错误
  • 测试以确保您的代码不会破坏任何其他功能
  • 你确定吗? 再次测试。

既然您已经仔细检查了所有内容,那么该提交PR了!

  • 为您的拉取请求加上标题,以使您的审阅者确切知道您的代码的含义。 可能和您使用的功能一样简单。
  • 在描述中,描述代码的作用以及以这种方式编写代码的原因。
  • 如果PR有关联的票证,则包括“修正”,“关闭”等,“#”和票证编号。 这样,一旦批准并合并PR,票证将自动关闭。
  • 提交!

谢谢文档作者! 这是很棒的建议,将使我立即成为一名更好的软件开发人员!

不客气,读者。 任何时候。

Akash Shah 是Codebase的应用开发学徒。 通过 hello@codebasesav.com 与他 联系