4. 我应该做些什么?

4.1. 良好的首个问题

我们有一个“良好的首个问题”标签 <https://github.com/ansible/awx/issues?q=is%3Aopen+label%3A%22good+first+issue%22+label%3Acomponent%3Adocs+),我们将其放在一些文档问题上,这些问题可能是新贡献者使用以下过滤器的一个良好的起点

is:open label:"good first issue" label:component:docs

修复和更新文档始终受到赞赏,因此查看问题的积压工作始终是一个良好的起点。

4.2. 提交修订前需要了解的事项

  • 请在您与社区的所有互动中遵循Ansible 行为准则

  • 所有文档修订或添加均通过针对devel分支的拉取请求完成。

  • 您必须对任何要合并的提交使用git commit --signoff,并同意使用--signoff构成对DCO 1.1条款的同意。

  • 注意确保提交中没有合并提交,并出于此原因使用git rebase而不是git merge。- 如果与其他人合作处理同一个分支,请考虑使用--force-with-lease而不是--force。这将防止您意外覆盖其他人推送的提交。有关更多信息,请参阅git push 文档

  • 如果提交了较大的文档更改,最好加入Ansible 论坛,并首先讨论您想做什么或添加什么。使用#documentation#awx标签来帮助通知相关人员主题。这不仅有助于每个人了解正在发生的事情,而且如果社区决定需要进行某些更改,还有助于节省时间和精力。

注意

  • 问题分配仅针对项目的维护人员进行。如果您决定处理某个问题,请随时在问题中添加评论以告知其他人您正在处理它;但请注意,我们将接受能够解决问题的任何人的第一个拉取请求。接受您的 PR 后,我们可以根据您的请求将您添加为问题的分配者。

  • 如果您处理的是正在积极开发的文档部分,您的更改可能会被拒绝,或者您可能会被要求rebase。在开始工作之前,一个好主意是与社区进行讨论

  • 如果您发现 UI 或 API 功能存在问题,请参阅报告问题部分以打开问题。

  • 如果您发现文档本身存在问题,请参阅报告问题

4.3. 翻译

目前我们不接受语言翻译的 PR。