1.5 KiB
1.5 KiB
贡献指南 (Contributing Guide)
感谢你对 GeminiWX 项目感兴趣！我们欢迎任何形式的贡献，包括提交 Bug 报告、改进文档、提出新功能建议或直接提交代码。
1. 提交 Issue
在提交 Issue 之前，请先搜索现有的 Issues，避免重复提交。
- Bug 报告: 请详细描述 Bug 的重现步骤、预期行为和实际行为，并提供相关的日志或截图。
- 功能建议: 请清晰地描述你想要的功能以及它解决了什么问题。
2. 代码开发规范
本项目遵循一定的代码规范，请在提交代码前仔细阅读。
- 详细规范: 请参考 admin/specification.md
- 后端 (Python/Django): 遵循 PEP 8 规范。
- 前端 (Vue.js): 遵循 Vue 风格指南，保持代码整洁。
3. 提交 Pull Request (PR)
- Fork 本仓库到你的个人账号。
- Clone 你的 Fork 到本地。
- 创建一个新的分支进行开发：
git checkout -b feature/your-feature-name或git checkout -b fix/your-bug-fix。 - 提交你的更改：
git commit -m "feat: add new feature"(推荐遵循 Conventional Commits 规范)。 - Push 到你的远程仓库：
git push origin feature/your-feature-name。 - 在 GitHub 上提交 Pull Request。
4. 开发环境搭建
请参考 STARTUP.md 快速搭建开发环境。
5. 许可证
参与本项目即表示你同意遵守本项目的开源许可证。