跳到主要内容

如何贡献

确定贡献领域​

有几种方法可以确定你能为 TON 文档贡献的领域：

  • 加入 Telegram 中的 TON 文档社团频道，从维护者那里获取最新任务。
  • 如果你有一个特定的关于贡献的想法，但不确定是否合适，请直接联系文档维护者确认。
  • 熟悉 TON 开发者 聊天中最常被问到的问题。
  • 请查看 GitHub 库中的issues。
  • 了解文档的可用的开发奖金。

简而言之​

  • 如果你需要在 TON 文档中添加或编辑内容，请针对 main 分支创建一个拉取请求。
  • 文档团队将审查拉取请求或在需要时联系你。
  • 库：https://github.com/ton-community/ton-docs

开发​

在线一键贡献设置​

你可以使用 Gitpod（一个免费的、在线的、类似 VS code 的 IDE）来进行贡献。它将一键启动并创建一个工作空间：

在 Gitpod 中打开

代码惯例​

  • 最重要的是：多多阅读文档。匹配项目的整体风格。这包括格式、文件命名、在代码中命名对象、在文档中命名事物等等。
  • 对于文档来说：编辑文档时，不要在 80 个字符处换行；相反，配置你的编辑器进行软换行。

总的来说，不用太担心惯例问题；维护者会在审查你的代码时帮你修正它们。

拉取请求​

你需要通过拉取请求将代码贡献回上游。你已经付出了很多努力，我们很感激。我们会尽力与你合作并审查拉取请求。

提交拉取请求时，请确保以下内容：

  1. 保持你的拉取请求小。较小的拉取请求（大约 300 行差异）更容易审查，也更有可能被合并。确保拉取请求只做一件事，否则就请拆分它。
  2. 使用描述性标题。建议遵循提交消息的惯例。
  3. 测试你的更改。在拉取请求的描述中讲述你的测试计划。

所有拉取请求都应在 main 分支上打开。

接下来的事情​

TON 文档团队将监控拉取请求。请遵循上述指南帮助我们保持拉取请求的一致性。