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。