为 Selenium 文档做贡献
Selenium是一个大型软件项目, 其网站和文档是了解事情如何工作以及学习有效利用其潜力的关键.
该项目包含Selenium的网站和文档. 这是一项持续的工作(不针对任何特定版本), 用于提供有效使用Selenium、 如何参与以及如何为Selenium做出贡献的更新信息.
对网站和文档的贡献遵循以下部分中有关贡献的描述.
Selenium项目欢迎每一个人的贡献. 您可以通过多种方式提供帮助:
上报问题
在报告新问题或评论现有问题时, 请确保讨论与Selenium的软件、 其站点与文档的具体技术问题相关.
随着时间的推移, 所有Selenium组件的变化都非常快, 因此这可能会导致文档过时. 如前所述, 如果您确实遇到这种情况, 请不要为此担心. 您也可能知道如何更新文档, 因此请向我们发送包含相关更改的Pull Request.
如果不确定所发现的问题是否存在, 请通过以下沟通渠道进行描述 https://selenium.dev/support.
贡献
Selenium项目欢迎新的贡献者. 随时间做出重大贡献的个人将成为 提交者 , 并获得对该项目的提交权限.
本指南将指导您完成贡献的过程.
步骤 1: Fork
在 Github上Fork本项目, 并check out到您的本地
依赖: Hugo
我们使用 Hugo 和 Docsy theme 用于构建和渲染本网站. 你需要Hugo“extended”扩展的Sass/SCSS版本用于这个网站. 我们推荐使用0.101.0或更高版本的Hugo.
请参考来自Docsy的说明 安装Hugo .
步骤 2: 分支
创建一个功能分支并开始工作:
我们实践基于HEAD的开发模式, 这意味着所有更改都直接应用在trunk之上.
步骤 3: 做出改变
本仓库包含站点和文档.
在开始进行更改之前,
请初始化子模块并安装所需的依赖项
(请参阅下面的命令).
要对网站进行更改,
请使用 website_and_docs
目录.
要查看更改的实时预览,
请在站点的根目录上运行 hugo server
.
请参阅 样式指南 , 以了解更多关于我们约定的信息
步骤 4: 提交
首先确保git知道您的姓名和电子邮件地址:
编写良好的提交信息很重要. 提交信息应描述更改的内容, 原因以及已解决的参考问题(如果有). 撰写时应遵循以下规则:
- 第一行应少于或等于50个字符, 并包含对该更改的简短说明.
- 保持第二行空白.
- 在所有72列处换行.
- 包括
Fixes #N
, 其中 N 是提交修复的问题编号(如果有).
一个好的提交信息可能看起来像这样:
第一行必须有意义, 因为这是人们在运行 git shortlog
或 git log --oneline
时看到的内容.
步骤 5: Rebase
使用 git rebase
(并非 git merge
) 同步实时的工作.
步骤 6: 测试
永远记住要运行本地服务, 这样做可以确保您的更改没有破坏任何事情.
步骤 7: Push
访问 https://github.com/yourusername/seleniumhq.github.io.git 并点击 Pull Request 以及填写表格. 请明确您已经签署了CLA (详见步骤 7).
Pull requests通常会在几天内进行审核. 如果有评论要解决, 请在新提交(最好是修正)中应用您的更改, 然后推push到同一分支.
步骤 8: 集成
代码审查完成后, 提交者将获取您的PR并将其集成到项目的trunk分支中. 因为我们希望在trunk分支上保持线性历史记录, 所以我们通常会squash并rebase您的分支历史记录.
沟通
有关如何与项目贡献者和整个社区进行沟通的所有详细信息, 请访问以下网址 https://selenium.dev/support