CONTRIBUTING.md

Contributing

感谢您对 此项目 的兴趣！我们欢迎社区贡献并鼓励您参与其中。以下是有关如何贡献代码、报告问题和提出功能建议的指导。

参与方式

1. 提交 Bug 报告 🐞

如果您发现了 Bug，请提供以下信息来帮助我们快速定位问题：

• 问题描述：简洁明了地描述 Bug。
• 重现步骤：列出清晰的步骤，说明如何触发该问题。
• 期望结果：您期望的行为是什么。
• 实际结果：当前行为或错误信息。
• 环境：操作系统版本、应用版本、依赖的库等。

2. 提出功能请求 🚀

如果您有想法来增强功能，请提供以下信息：

• 功能描述：简洁描述功能请求。
• 使用场景：您希望如何使用该功能，或解决什么问题。
• 优先级：此功能对您有多重要？是否可以延后？

3. 提交代码 🧑‍💻

如果您想直接为项目贡献代码，请遵循以下步骤：

步骤 1：Fork 本项目

• 点击右上角的 Fork 按钮，将本仓库复制到您的 GitHub 账户下。

步骤 2：克隆到本地

git clone https://github.com/您的用户名/项目名称.git

步骤 3：创建分支

请为您的修改创建一个新的分支：

git checkout -b feature/您的功能名

步骤 4：进行修改

在本地进行代码更改或修复 Bug。确保按照项目的代码风格和开发规范进行编写。

步骤 5：提交更改

提交您的更改，并写出清晰的提交信息：

git add .
git commit -m "简短描述您的更改"

步骤 6：推送到远程

将您的更改推送到 GitHub：

git push origin feature/您的功能名

步骤 7：创建 Pull Request

• 进入您的 Fork 仓库，点击 Compare & Pull Request 按钮。
• 选择目标分支（通常为 main 或 master），并添加清晰的描述说明您的更改。
• 提交 Pull Request，等待维护者审查。

提交代码规范

• 请确保您的代码通过了项目的测试用例（如果有）。
• 确保遵循代码风格和格式，尽量避免修改与您更改无关的部分。
• 提交信息应简洁明了，描述清楚您所做的更改。
• 如果您的更改涉及到文档更新，请同时更新相关文档。

代码风格

• 使用统一的缩进（如 2 或 4 个空格，保持一致）。
• 变量命名应简洁且有描述性，遵循适当的命名规则。
• 代码行长度尽量保持在 80-120 个字符以内。
• 使用注释来解释复杂的逻辑。

文档贡献 📚

如果您希望改善文档，欢迎提交 PR。文档的改进对新用户非常重要，您可以帮助我们：

• 改进安装说明
• 添加/更新功能文档
• 改进教程或示例代码

社区行为准则

在提交问题、PR 或其他任何形式的贡献时，请遵守以下行为准则：

• 尊重他人：无论在报告问题、请求功能，还是代码审查过程中，都要始终保持尊重与友好。
• 贡献开放性：欢迎任何形式的贡献，不论大小，每一份贡献都值得重视。
• 保持建设性：保持讨论的建设性和积极性，避免无意义的批评。

许可证

本项目遵循 LGPL-3.0 License。

---

我们非常感谢您的贡献，期待您的加入！如果您有任何问题，随时可以在 Issues 区域提问，或者直接联系项目维护者。