Corners
Width
Accent
Headings
Body text
Dark theme
White theme
Mordhau Guides 1.0.0 现已发布——指南已进入稳定版本,也始终欢迎修正建议。
这里没什么复杂的。它主要是一个列表,可以让审查您的拉取请求的人不必询问。
为以前从未这样做过的人编写。 该项目存在的原因是现有的 Mordhau 文档假设您已经知道答案。如果某个步骤需要先决条件,请说出来。
具体一点。 “编辑配置文件”没有用。“打开Mordhau/Saved/Config/LinuxServer/Game.ini”是。
当您不确定时请说出来。 说明某个值未经测试的注释远比确信的错误数字要好。会有人过来确认。
保留现有结构。 如果某个部分已有模式,请遵循该模式,而不是在页面上发明新的模式。
测试你写的内容。如果您正在记录命令,请运行它。如果您正在记录配置密钥,请将其放入真实的 Game.ini 中并启动服务器。
如果您从其他地方(另一个站点、Discord 消息、托管提供商的知识库)获得信息,请链接它。两者都是为了让读者可以更深入地了解它,这样下一个人就可以知道它有多陈旧。
游戏更新中断文档。如果您发现某个页面描述的内容不再与游戏匹配,修复它也算作贡献。
将一个拉取请求保留到一个主题。修复拼写错误并重写 RCON 页面的 PR 很难审查,也很难恢复。
为其指定一个标题,说明更改的内容。“更新”没有告诉审稿人任何信息。
在提交之前在本地运行网站:
npm run docs:dev检查您的页面是否呈现,您的链接是否到达您认为的位置,并且没有其他任何损坏。
如果审核返回变更请求,则不是拒绝。将另一个提交推送到同一分支,并且拉取请求会自行更新。
文明一点。这里的人们是志愿者,在空闲时间用通常不是他们的母语的语言编写游戏文档。纠正的是内容,而不是人。
您保留所写内容的版权。通过贡献,您可以在 CC BY-SA 4.0 (英语). 下向该项目和其他所有人授予许可,并且您的信用记录在提交历史记录中。
不要贡献任何您无权发布的内容。