如何为波卡 Wiki 做出贡献

Polkadot生态研究院2023-03-24 18:00

“波卡知识图谱”是我们针对波卡从零到一的入门级文章,我们尝试从波卡最基础的部分讲起,为大家提供全方位了解波卡的内容,当然这是一项巨大的工程,也充满了挑战,然而我们希望通过这样的努力让大家能够正确认知波卡,也让不了解波卡的人方便快速掌握波卡相关知识,今天是该栏目的第 88 期,波卡拥有非常完备和丰富的 Wiki,供不同的建设者和参与者学习和了解,因此让 Wiki 得到更广泛的传播需要更多人参与到对 Wiki 的建设中,本期,我们将介绍官方提供的如何为 Wiki 做出贡献的教程。



波卡的 Wiki 由 Web3 基金会启动和维护。它是一个开源项目,旨在成为 Polkadot 和 Kusama 生态系统中最大的知识资源。目前有很大一部分资料都是围绕着 Polkadot 和 Kusama,但并也包含覆盖社群项目的信息材料。

尽管如此,还是鼓励来自社区的 Pull Request*、讨论和贡献。可以向表现出良好贡献记录的活跃社区成员授予对存储库的写入权限。

编者注:Pull Request*:是一种 GitHub 等在线 git 服务的功能,让你可以向一个仓库(repository)提出修改建议,即使你没有访问该仓库的权限。你可以使用 pull request 来进行开源协作,或者在团队中进行代码审查。

Web3 基金会对包含的内容拥有管理地位和最终决定权。具体来说,基金会的技术教育团队是起到主导地位的。



如何贡献


您可以在存储库上为 Wiki 做贡献。每个页面都是一个 MarkDown 文件,这是一种易于学习的纯文本语法扩展,可以轻松创建链接、渲染图像和美观的格式。


每个页面的内容底部都有一个“编辑此页面(Edit this page)”链接。通过单击它,您将被带到 GitHub 登录页面,您可以在其中登录或创建一个帐户。


登录后,您将被带到 GitHub 内置的文本编辑器,您可以在其中直接进行编辑。完成更改后,您可以添加有关更改内容的任何特定详细信息,并提交到新分支以向存储库创建新的合并请求。其中一位维护者将审查您的更改,然后合并它们或请求更改。


存储库,详情请参见:

https://github.com/w3f/polkadot-wiki




请记住,在您点击“Propose Changes”之后,您还必须在下一页点击“Create Pull Request”。




贡献指南和规则


贡献者有一些基本的基本规则:
1.不得以任何 --force 方式推送或修改 Git 历史记录。
2.与 issues 功能相比,更推荐使用 Pull request,尤其是对于拼写错误等小的更改。issues 应该用于通用或基础广泛的更改或缺失的内容。鼓励大家提出建议和要求。
3.只使用 non-master 分支。
4.重大修改,即使是贡献者所做的,也应该受到 Pull request 的约束,以征求其他贡献者的反馈。
5.鼓励对任何其他重要贡献征求反馈的 Pull request,但由贡献者自行决定。
6.贡献者应尝试坚持流行的 MarkDown 风格、语言和布局。
7.应始终使用正确的语法。有拼写错误的 Pull request 在修复之前不会被合并。
8.应注意尽可能保持客观和信息丰富。不应有主观评论,也不应存在外部偏见。
9.我们使用一个名为 Prettier 的插件来标准化跨文档的样式。可以用 npx pretty-quick --staged 本地副本上运行它,但为简单起见,我们还有一个机器人可以在您的 PR 中运行。


继承


资料来源,详情请参见:

https://github.com/Level/community/blob/master/CONTRIBUTING.md



帮助翻译


Wiki 的默认语言是英语,但我们希望将 Wiki 翻译成尽可能多的语言。您可以做出贡献的另一种方式是帮助翻译。


Polkadot Wiki 主页底部有一个功能,可以将您重定向到 crowdin,这是可以进行翻译贡献的地方。在那里,您将看到以多种不同语言翻译与 Wiki 相关的文档的进度。


crowdin,详情请参见:

https://crowdin.com/project/polkadot-wiki



以下是有关如何在 crowdin 界面应用以进行翻译的步骤。也可以查看官方的 crowdin 知识库。


官方的 crowdin 知识库,详情请参见:

https://support.crowdin.com/online-editor/








下面显示了阿拉伯语的示例。您可以在提供的区域中为每个部分输入所需的翻译,同时也可以使用 crowdin 内置翻译器生成的建议。




记得将您的内容存档。







欢迎大家加入我们 Polkadot 生态研究院的电报:

https://t.me/polkadot_eri

欢迎大家访问波卡生态研究院的 Mirror 地址:
https://mirror.xyz/0x9A259b3a2316281Cc948cE2Cf1Ac610a79844f05




精选文章



平行线程 | 经济模型 |Slash | 通货膨胀 | NPoS | Web3 基金会
Staking
 | Gavin Wood | 跨链 | 平行链 | 国库 | Parity
DOT | Web3.0 | 网络效应 | Grant 指南
Statemint | 区块链 | SBP 计划 | 新计划
XCVM | BEEFY | XCM
Wasm



 


【免责声明】市场有风险,投资需谨慎。本文不构成投资建议,用户应考虑本文中的任何意见、观点或结论是否符合其特定状况。据此投资,责任自负。

来源链接

相关Wiki

相关标签