贡献指南
欢迎来到 Aleo 开发者文档。Aleo 坚持开源和去中心化,也欢迎社区以各种方式参与贡献。无论是提出新主题、补充内容,还是增加示例来提升文档的清晰度和实用性,都是有价值的贡献。
简介
Aleo 是一个完全开源、去中心化、可编程、以隐私为核心的 Layer 1 区块链。开发者可以在 Aleo 上构建内置隐私能力的应用。借助零知识证明,部署在 Aleo 上的程序可以在保密敏感数据的同时保持可验证性。Aleo 同时具备较高的可扩展性和更少受限的运行环境,因此适合构建下一代隐私型去中心化应用。
如果你想进一步了解 Aleo 的架构和特性,可以继续阅读 Concepts 部分。
帮助改进 Aleo 生态
提交 ARC 提案
如果你对开发标准或协议改进有想法,可以通过 ARC(Aleo Request for Comments)流程提出提案。
创建新的 ARC 提案:
- 先在 GitHub Discussions 中使用
ARC-0000模板并选择一个可用的 ARC 编号,发起讨论。 - 然后在一个新的子目录中提交包含提案内容的 Pull Request。
更新已有 ARC:
- 直接提交包含修改内容的 Pull Request。
- 如果改动较大,维护者可能会要求你开启一个新的 ARC。
ARC 的推进流程
ARC 一开始通常处于 Draft 状态,后续会按以下流程推进:
- 社区开始讨论和审查提案。维护者会跟进 ARC,并在合适时将状态改为
Active。 - ARC 的优先级通常会参考投票数量以及是否已有原型实现。
- 某些 ARC 会在社区会议中讨论,提案人也有机会参与讨论。
- 在这之前,如果提案长期没有进展,提案人或维护者都可以选择撤回。
- Aleo Network Foundation(ANF)的 governor 或团队成员会在 Aleo 治理平台发起正式提案并进入投票流程。
- 社区对提案进行投票。
- 如果提案通过,其状态会更新为
Accepted,对应 PR 会被合并进 ARCs 仓库;如果未通过,则状态会回退为Draft。 - 相关实现方完成后续落地。期间仍可通过新的 PR 继续更新 ARC,这类更新通常不需要再次投票。
- 当实现最终完成后,状态会从
Accepted变为Final或Living,具体取决于提案性质;对应讨论也会被关闭。
如果某个提案被新的提案替代,它也可能进入 Deprecated 状态。
关于状态定义的更多说明,请参考 ARC-0001。
为 Aleo 各组件贡献
构成 Aleo 的各个组件都是开源的,也欢迎各种类型的贡献,包括这份开发者文档本身。每个组件都有各自独立的贡献指南,常见入口包括:
- Leo:用于在 Aleo 上编写程序的 Rust DSL。
- Provable SDK:用于创建零知识应用的 JavaScript / TypeScript 工具。
- Create-leo-app:用于创建 Aleo 项目脚手架的工具。
- Aleo Instructions:Leo 编译后的 IR。
- SnarkOS:Aleo 的节点客户端。
- SnarkVM:执行可验证计算的虚拟机。
如果你只是准备开始参与,最简单的起点通常是文档、示例、说明补充或问题反馈。