/solidity-doc-cn

以太坊Solidity语言中文文档

Primary LanguagePython

Solidity中文官方文档

工作指南

Github使用基础

参见廖雪峰的Git和Github指南

RST文档基础

RST文档格式的一个中文说明

工作流

  1. 注册Github帐号
  2. 申请加入Solidity翻译团队
  3. fork仓库: https://github.com/etherchina/solidity-doc-cn
  4. develop: 在README中更新，认领需要翻译的章节，请务必加入commit hash值，命令见常见问题。
  5. develop: 翻译，完成后提交PR
  6. develop: 在提交PR或git push的时候注意：一定要先同步主仓库源，见常见问题
  7. develop: Reviewer审核之后merge，由校对人员校对
  8. master: 确认质量后由admin合并入master

工作进度

示例：<文件名>: [@github-id] [翻译中|翻译完成] [审校人] [未审校|审校中|审校完成] (英文源文件commit hash)

  1. index.rst: @hongbinzuo 翻译完成 未审校 （01ba8b7e1fbdcb1b26820fd7b8908e43fb367e82）
  2. introduction-to-smart-contracts.rst: @hongbinzuo 翻译中(f58024b9744f557dbc77d5f7bfbc4319bde2e0c7)
  3. structure-of-a-contract.rst: @bobjiang 翻译中 (f58024b9744f557dbc77d5f7bfbc4319bde2e0c7)

贡献者列表

  1. 姜信宝
  2. 左洪斌

常见问题

  1. fork出的仓库如何同步源的内容：https://www.zhihu.com/question/28676261
  2. 如何检查文件(参考Solidity英文文档仓库)的提交哈希：git log filename.rst
  3. 文档如何构建：https://solidity-cn.rtfd.io 是我们的托管地址，readthedocument这个网站是免费的，可以关联多个仓库，并且可以由git push触发自动构建，以达到文档更新的目的。
  4. 原英文文档更新怎么办：我们需要人去定期检查英文文档的更新，使用commit hash来比较更新，如果有更新，我们发起翻译请求，翻译后提交。后续我们会开发跟踪脚本，每天检查文档文件的更新，以确定是否有新的翻译工作。
  5. rst文档中中文斜体无法展示，此问题尚待解决

术语表

参见glossaries.md

参考资料

参见references.md