你好,我是 Lemo,LemoBook 的创建者。我很高兴欢迎你加入我们的项目, 期待你为让 LemoBook 变得更好做出贡献!
为 LemoBook 贡献代码
你好!我是 Lemo,LemoBook 的创建者。我很高兴你对为我们的项目做出贡献感兴趣。本指南旨在帮助你了解如何参与构建和改进 LemoBook。无论是修复错误、添加新功能,还是改进文档,你的贡献都非常宝贵,我们深表感谢。让我们一起努力,使 LemoBook 变得更好!
首先,感谢你考虑为 LemoBook 做出贡献!正是像你这样的人使 LemoBook 成为一个出色的工具。
行为准则
参与本项目时,你需要遵守我们的行为准则。如遇到不当行为,请向 [project_email@example.com] 报告。
如何贡献?
报告错误
本节将指导你提交 LemoBook 的错误报告。遵循这些指南有助于维护者和社区理解你的报告、复现问题行为并找到相关报告。
提交错误报告前
- 查看文档中的常见问题和问题列表。
- 在 GitHub 的 Issues 中搜索,确保该错误尚未被报告。
如何提交(好的)错误报告?
错误通过 GitHub issues 进行跟踪。创建 issue 并提供以下信息:
- 使用清晰描述性的标题来标识问题。
- 详细描述重现问题的具体步骤。
- 提供具体示例来演示这些步骤。
建议改进
本节将指导你为 LemoBook 提交改进建议,包括全新功能和对现有功能的小改进。
提交改进建议前
- 检查该改进是否已被建议。
- 确定应该在哪个仓库中提出改进建议。
如何提交(好的)改进建议?
改进建议通过 GitHub issues 进行跟踪。创建 issue 并提供以下信息:
- 使用清晰描述性的标题来标识建议。
- 详细描述建议的改进步骤。
- 提供具体示例来演示这些步骤。
你的第一个代码贡献
不确定从哪里开始为 LemoBook 做贡献?你可以从这些 beginner
和 help-wanted
议题开始:
Pull Requests
这里描述的过程有几个目标:
- 维护 LemoBook 的质量
- 修复对用户重要的问题
- 让社区参与到打造最好的 LemoBook 的工作中
- 为 LemoBook 的维护者建立一个可持续的系统来审查贡献
请按照以下步骤提交你的贡献:
风格指南
Git 提交消息
- 使用现在时态("Add feature" 而不是 "Added feature")
- 使用祈使语气("Move cursor to..." 而不是 "Moves cursor to...")
- 第一行限制在 72 个字符以内
- 第一行之后自由引用议题和 pull requests
JavaScript 风格指南
所有 JavaScript 代码必须遵循 JavaScript Standard Style。
文档风格指南
- 使用 Markdown。
许可证
通过贡献,你同意你的贡献将根据 MIT 许可证进行许可。
有问题?
如果你有任何问题或需要进一步说明如何贡献,请随时联系项目维护者。
感谢你对 LemoBook 的贡献兴趣!我们期待你的贡献,并一起努力使 LemoBook 变得更好。