Anchor 中文文档Anchor 更新
贡献指南
Anchor - 贡献指南
感谢您对 Anchor 做出贡献的兴趣!无论大小,所有贡献都是受欢迎的。这包括(但不限于)提交问题、添加文档、修复 bug、创建示例和实现功能。
寻找可处理的问题
如果您想开始贡献,请查看 good first issues 或需要 help is wanted。对于简单的文档更改或拼写错误,请随时直接打开一个 pull request。
如果您考虑较大的更改或自发的功能,请提交一个问题,并在 Discord 中与维护者交流。
选择一个问题
如果您想贡献,请通过评论、fork 并打开一个 pull request(即使是空的)来认领一个问题。这使维护者能够跟踪谁在处理什么问题,以避免工作重叠。
问题指南
请遵循以下指南:
编码前:
- 选择一个描述您正在处理的问题的分支名称
- 启用 commit signing
编码时:
- 尽快提交一个 draft PR
- 只更改与您的 PR 直接相关的代码。有时您可能会发现一些代码确实需要重构。然而,如果它与您的 PR 无关,请不要动它。而是提交一个问题。这使审阅者能够一次专注于一个问题。
- 如果您写注释,每行不要超过 80 个字符。这样可以让使用多个打开窗口的贡献者仍然可以阅读注释,而不需要水平滚动。
- 编写对抗性测试。例如,如果您添加了一个新的账户类型,不仅要编写指令成功通过的测试,还要编写测试来测试如果新类型中的检查被违反,指令是否会失败。
编码后:
- 如果您移动了代码,请使用
cargo doc --open
构建文档并调整破损的链接 - 如果需要,请调整 CLI 模板
- 如果您对 Anchor 的外围(avm 或 cli)进行了更改,请在必要时向
anchor-book
仓库提交 PR