比特币核心(Bitcoin Core)的文档分布在多个项目和平台,包括 Bitcoin Core 本身、比特币维基(Bitcoin Wiki)以及 Bitcoin.org。这些文档又被进一步细分为不同部分,方便开发者、测试者和用户按需查阅。本文将为您梳理可用的文档资源,并详细介绍如何参与贡献。
Bitcoin Core 开发者文档
Bitcoin Core 的开发者文档主要托管在 developer.bitcoin.org GitHub 仓库中。这些文档几乎全部面向开发者和测试人员,内容涵盖技术细节、接口说明和开发指南。
您可以通过 GitHub 的网页界面轻松编辑这些文档:
- 创建或登录您的 GitHub 账户。
- 找到您想要编辑的文件。
- 点击编辑图标(铅笔形状)。
- 进行修改后,点击预览按钮查看效果,反复修订直至满意。
- 在页面底部填写“提议文件更改”表单并提交。
如需帮助,可以加入 #bitcoin-dev IRC 聊天室,告诉我们您想编写的文档内容。
Bitcoin.org 带宽共享指南
Bitcoin.org 上的带宽共享指南提供了在多操作系统上安装 Bitcoin Core 的详细说明,包括如何配置开机自动启动以及手动开放端口 8333 以接受传入连接。
贡献方法与前述类似:直接通过 GitHub 网页界面编辑指南文件。若需要协助,您可以提交问题或通过邮件联系 Bitcoin.org 文档维护者。
比特币维基(Bitcoin Wiki)
比特币维基使用流行的 MediaWiki 软件,编辑方式与维基百科类似。为减少垃圾信息,您需要创建账户并按照指南启用编辑权限。
现有的 Bitcoin Core 文档可在比特币核心文档分类中查找。创建新页面时,请确保将其添加到比特币核心文档模板中,并在页面底部加入以下代码:
{{Bitcoin Core documentation}}
添加这行代码后,页面会自动归入比特币核心文档类别。如果您需要编辑帮助,可以访问 #bitcoin-wiki IRC 聊天室交流。
Bitcoin.org RPC/REST API 参考
Bitcoin.org 开发者参考提供了超过 100 页的 Bitcoin Core RPC 和 REST 接口文档,主要面向命令行用户和依赖 Bitcoin Core 的应用程序开发者。
贡献 RPC 文档编辑的最简便方法如下:
- 访问 developer.bitcoin.org GitHub 仓库。
- 创建或登录您的 GitHub 账户。
- 定位要编辑的文件。
- 点击编辑图标(铅笔形状)。
- 修改后预览效果,调整至满意为止。
- 填写页面底部的更改提议表单并提交。
若需帮助,您可以提交问题或通过邮件联系文档维护者。
常见问题
问:参与比特币核心文档贡献需要什么条件?
答:您需要具备一定的比特币和区块链基础知识,熟悉 Markdown 或 Wiki 编辑语法,并拥有 GitHub 账户。对不同文档项目的贡献流程略有不同,但基本都通过在线平台完成。
问:文档贡献主要包括哪些类型的工作?
答:主要包括修正现有文档的错误、补充缺失的内容、翻译不同语言版本、更新过时信息以及创建新的技术指南等。各类贡献都受到社区欢迎。
问:如何选择适合自己的贡献方向?
答:根据您的技能和兴趣选择:开发者更适合技术API文档,测试人员可关注测试指南,普通用户则可帮助改进使用说明和常见问题解答。👉 查看实时贡献机会
问:文档贡献会被审核吗?审核流程是怎样的?
答:是的,所有贡献都会经过社区审核。在GitHub上通过Pull Request流程进行,由维护者和社区成员审查修改;Wiki编辑则经过权限审核和内容验证。
问:贡献文档有什么好处?
答:除了帮助完善比特币生态系统外,贡献者可以加深对比特币技术的理解,建立专业声誉,并成为全球比特币社区的一员。