---

D.2.4 为 Octave 发送补丁 ¶

如果您愿意为 Octave 编写错误修复或改进代码，那将非常有帮助。在发送您的更改时，请遵循以下指南，以避免我们在研究补丁时产生额外的工作。

如果您不遵循这些指南，您的信息可能仍然有用，但使用它会增加额外的工作。即使在最理想的情况下，维护 Octave 也是一项繁重的工作，除非您尽力提供帮助，否则我们无法跟上进度。

• 随更改一起发送一份说明，解释它们修复了什么问题或带来了什么改进。对于错误修复，只需附上错误报告的副本，并解释为什么该更改修复了错误。
• 对于您认为已修复的问题，始终附上相应的错误报告。在安装更改之前，我们需要说服自己该更改是正确的。即使它确实是正确的，如果我们没有办法重现问题，我们也可能难以判断。
• 包含所有适当的注释，以帮助将来阅读源代码的人理解为什么需要进行此更改。
• 不要将出于不同原因所做的更改混在一起。 请逐个发送它们。

  如果您出于不同原因进行了两次更改，我们可能不会同时安装它们。我们可能只想安装其中一个。

• 使用 ‘diff -c’ 来生成差异文件。没有上下文信息的差异文件我们很难可靠地安装。更重要的是，它们让我们难以研究差异以决定是否要安装它们。统一 diff 格式比无上下文 diff 更好，但不如 ‘-c’ 格式易于阅读。

  如果您有 GNU diff，请使用 ‘diff -cp’，它会显示每次更改所在的函数名称。

• 为您的更改编写变更日志条目。

  阅读 ChangeLog 文件以了解需要放入哪些信息，并学习我们使用的风格。变更日志的目的是向人们展示在哪里可以找到更改的内容。因此，您需要具体说明更改了哪些函数；在大型函数中，指出函数中进行更改的位置通常很有帮助。

  另一方面，一旦您向人们展示了在哪里可以找到更改，就无需解释其目的。因此，如果您添加了一个新函数，您只需说明它是新的。如果您觉得需要解释其目的，那么它可能确实需要解释——但如果您将其放在代码的注释中，解释会更加有用。

  如果您希望您的姓名出现在做出更改的标题行中，请将标题行发送给我们。