47 · 贡献指南（Contributing）

开源是一件美妙的事。我们欢迎向 Embabel 项目贡献。

如何贡献

• 先阅读文档来熟悉项目；
• 熟悉 issue tracker 与已打开的 pull request，确保你没有在做重复的事；
• 对你的 commit 进行签名（sign your commits）；
• pull request 必须附描述。没有描述的 PR 会被关闭。
• 加入 Embabel 的 Discord 社区：https://discord.gg/t6bjkyj93q。

贡献不限于代码

你也可以通过以下方式帮忙：

• 改进文档
• 报告 bug
• 提出新特性建议
• 在 Discord 上参与社区交流
• 创作示例与其它材料
• 在 meetup 和会议上介绍 Embabel
• 在社交媒体上发布关于 Embabel 的内容

关于用 LLM 辅助贡献

贡献代码时，欢迎用编码 Agent 与 LLM 提升你的效率，但要避免以下坑：

• 大量毫无价值的 LLM 注释 —— 代码应当自解释。注释留给不明显的地方。
• 冗长的 PR 描述及其它内容。

不是针对谁，但这类贡献会被自动拒绝。

你必须理解你所贡献的任何内容。