我是否应该提交拉动请求以更正自述文件中的小错别字？

#1 楼

只需修复您注意到的所有错别字，并按照“修复错别字”的行创建带有注释的拉取请求。然后，只需单击一个按钮，即可选择具有正确访问权限的人。
您无需解释每一个错别字；差异本身将很明显。
从电子邮件中获取有关错别字的信息将更难以向开发人员申请（甚至对您而言可能更难）。

#2 楼

一家名为DigitalOcean的云托管提供商每年都会举办一次名为Hacktoberfest的活动，以鼓励人们为开源项目做出贡献，以换取一件T恤。这样做很有趣，因为它可以鼓励更多的人使用开源软件，提供奖励以换取可玩游戏的指标并将其打包到一个月内，从而导致许多项目收到大量低质量的请求，这些请求被一些维护者视为垃圾邮件。其中许多涉及对README文件的琐碎改动或破坏，其中一些灵感来自YouTube频道上的演示。注释或此注释，它向README添加了一个奇怪且不必要的标头。今年特别值得注意，有些活动在活动的第一天就收到了十几个，这引起了项目维护者和DigitalOcean的Hacktoberfest的博客帖子Hurting Open Source的震惊。
Hacktoberfest结束了，至少到明年，这种特定的问题已经减弱（垃圾邮件的数量使他们在几天后改变了该程序的工作方式，使其选择加入项目维护人员），但是该事件提供了一些背景信息多少维护者考虑拉动请求：存在PR以改进软件，而存在PR似乎只是为了改变目的而没有明确的目的或好处，尤其是在批量生产中，PR可能会被反对。如果您只是修正注释中的拼写错误，似乎无缘无故地在更改文档，或者在没有进行任何特殊改进的情况下随意重写一些代码，那可能会引起您的注意。
但就您而言，您的PR似乎可以真正改善软件。在自述文件中有多种错别字，假设它们是真实的错字而不是区域拼写差异，则不理想，并且您通过修复它们来提供实质性的改进。
您问这个问题并且关心维护者的时间清楚表明您的意图是崇高的。最终，为了缓解您的顾虑，对于维护人员而言，复查和合并简单的请求请求是一项非常快捷且轻松的操作-查看diff并单击一个按钮。写下“这是我的第一个拉取请求。我希望这是有用的，但如果不是这样，不用担心”之类的东西，或者不确定的话，完全可以。

#3 楼

更正键入错误，并在摘要字段中提出每次更正的位置的拉取请求。 ，并且任何拉取请求审阅者显然都将查看所做的更改。
应保留摘要字段，以使人类容易理解该PR所包含内容的简短总和。在您的特定情况下，“修正了一些拼写错误”可以准确地总结出来。


向维护者发送一封电子邮件，其中包含建议的更正。


GitHub的全部目的是您可以协作地协调对源代码的更改。如果要通过电子邮件发送邮件并让他们进行更改是必经之路，那么GitHub（以及一般的版本控制系统）将失去其主要目的。其成员如何协调他们所做的更改。
我考虑向维护者发送电子邮件的唯一原因是澄清一些东西，例如如果您不确定某件事是否是意外行为。
在这种情况下，真的不需要弄清楚错别字修复的简单PR，维护人员可以查看PR本身并决定是否需要它们。 。与打开PR本身相比，您将花费更多的时间来尝试让他们查看所有内容并询问您的更正是否正确。 br />

什么也不做。


我的意思是，从技术上讲，这是一种选择，但它并没有完全解决您应该如何解决这一问题。这样一个问题的内在含义是，您正在尝试做自己想做的事情。无所事事无所事事。

#4 楼

因为已经有了答案，但这并不是专门解决问题的方法，而是我向人们提供有关提交和消息的一般建议。我使用的示例是，如果您需要编辑的文件存在很多格式问题。您应该进行一次提交以更正格式，然后进行第二次提交以修复最初用于文件的逻辑。这样，如果出于某种原因需要还原逻辑，则空白空间可以留给下一个需要进入的人。理想情况下，您确定的格式符合本地编码标准。
对于个人提交的内容，请回答编写小学论文时所教的问题。什么？什么时候？哪里？为什么？
提交人通常会回答谁。
提交的时间戳记是什么时候
提交的差异通常在什么地方和哪里？
为什么以及如何确实需要在提交消息中。对我来说，这是许多软件工程师正确和辛苦地完成工作的最重要部分。
在这种情况下，由于更改很小，因此无关紧要，为什么您要修正错别字。
TLDR;不必担心会修正拼写错误或格式错误。提交并提交审核。

#5 楼

其他答案也不错，但是首先请检查是否有任何贡献说明，尤其是有关签署CLA的说明。
（我看到@eckes还将其作为对原始问题的评论。）如果CLA流程似乎过于复杂，那么最好只开一个拼写错误的问题（或发送电子邮件），而不是构建PR。