贡献于文档


贡献于文档

zkSync Era的文档是开源的,它欢迎来自世界各地的个人,包括你的社区贡献。

对任何大型项目的贡献都需要项目成员之间的合作,以及使经验富有成效和愉快的人和过程。

由于合作贡献zkSync文档是社区不可分割的一部分,有很多方法可以与其他做同样事情的人沟通并向他们学习。

贡献的方式

编辑或审查一个文档页面

目标

找到一个你认为需要更新、校对或编辑的文档页面。

背景和参考信息

内容风格指南open in new window - zkSync内容风格指南。

贡献的类别

审查该页面,看它是否需要编辑。需要注意的事项。

  1. 校对(拼写、语法、标点符号)。
  2. 所关注的特定页面是否遵循内容风格指南和文件结构指南,如果不遵循,你可以编辑。
  3. 404链接 - 进行编辑并创建一个PR来修复任何断裂的链接。
  4. 语言翻译 - 如果你想把zkSync文档翻译成非英语语言,我们会做一个指南供你参考。

详细步骤

  1. 在感兴趣的页面,点击 "编辑此页面"。
  2. 第1步将你带到GitHub:在GitHubopen in new window上创建一个账户,或者如果你已经有一个账户,那么就登录。
  3. 点击钢笔图标,就可以分叉该版本,这样你就可以开始为文档做贡献了。 fork-repo
  4. 编辑MD文件。
  • 我们在文档中使用markdown,你需要知道markdown才能为文档做贡献。
  • 在fork-repo之后对文件进行编辑并预览你的修改。如果你还没有阅读我们的内容风格指南open in new window,请在开始这一步之前阅读。
  1. 写下你所做修改的简要描述,然后点击 "提出修改"。
  2. 编辑完文件后,点击 "创建拉动请求",等待我们的审查员来审查你的PR。 create-pull-request

学习/改进资源。