FreeBSD 文档项目：提交文档

我编写了一些文档。如何提交？

首先，感谢您抽出时间来做这件事。

您应该公开您的文档以供审查。如果可以，请将其上传到某个网站。

然后向 FreeBSD-doc 邮件列表发布一条消息，简要概述文档及其位置的指针，并征求反馈。

如果由于某种原因，您无法将文档放在某个网站上，您可以将其直接发送到 FreeBSD-doc 邮件列表。如果您这样做，请仅发送纯文本文档。

您可能希望将此评论请求抄送至另一个合适的邮件列表。例如，与如何使用 Subversion 更新源代码树相关的内容会让 FreeBSD-stable 邮件列表的订阅者感兴趣。请最多仅抄送一个其他邮件列表。

在人们查看完您的文档并有机会纳入他们的任何建议后，您就可以提交了。

正确的做法是打开一个问题报告。有关此操作的说明，请参阅错误报告。

您这样做是为了跟踪您的提交。当您提交 PR（问题报告）时，会分配一个唯一的编号。然后，其中一位提交者可以将 PR 分配给自己，并与您协商提交新文档。有关更多信息，请参阅撰写 FreeBSD 问题报告。

确保“产品”设置为“文档”，并且“组件”根据需要设置为“文档”或“网站”。您应该将您之前的文件附加到 PR。如果合适，请同时提供指向讨论您的更改的邮件列表帖子的链接。

同样，感谢您抽出时间来做这件事。

首先，您需要生成一个名为 diff 的特殊文件。此 diff 显示您所做的更改。这使得执行提交的人员更容易查看您所做的更改，并且意味着您无需花费大量时间解释您所做的更改（尽管您仍然应该解释为什么您认为应该进行更改）。

要创建“diff”，您应该；

然后，对 foo.xml 进行更改

    % vi foo.xml
    ... tap tap tap ...

    ... test the changes, read them for typos and so on ...

创建 diff。执行此操作的命令为
```
    % diff -u foo.xml.old foo.xml > foo.diff
```
这会查看这两个文件之间的差异，并将它们写入文件 foo.diff。

然后，您可以将 foo.diff 发送回项目。如前所述发送 PR，并将 foo.diff 文件附加到 PR。

上次修改时间：2021 年 6 月 19 日，由 Danilo G. Baio 修改