CONTRIBUTING.md

贡献指南

首先,非常感谢您考虑为QRify做出贡献!🎉 每一个贡献都是宝贵的,无论大小。本指南将帮助您了解如何参与到项目中来。

目录

1. 行为准则
2. 我可以如何贡献?
3. 报告Bug
4. 提出新功能
5. 提交代码
6. 代码风格指南
7. 测试
8. 文档
9. 问题解答

行为准则

本项目采用贡献者公约。参与本项目即表示您同意遵守其条款。

我可以如何贡献?

有很多方式可以为QRify做出贡献:

• 报告Bug
• 提出新功能建议
• 改进文档
• 提交代码修复或新功能
• 帮助其他用户解答问题

报告Bug

如果您发现了bug,请通过GitHub Issues报告。创建issue时,请包含以下信息:

1. 清晰简洁的标题
2. 详细描述问题,包括复现步骤
3. 预期行为和实际行为
4. 截图(如果适用)
5. 您的浏览器版本和操作系统
6. 其他可能相关的信息

提出新功能

我们欢迎新功能建议!请通过GitHub Issues提交您的想法。在描述新功能时,请考虑:

1. 这个功能会解决什么问题?
2. 它如何融入QRify的现有功能集?
3. 这个功能的潜在用户群是谁?

提交代码

1. Fork 仓库
2. 克隆您fork的仓库到本地
3. 创建新的特性分支 (git checkout -b feature/AmazingFeature)
4. 进行修改
5. 提交您的改动 (git commit -m 'Add some AmazingFeature')
6. 推送到分支 (git push origin feature/AmazingFeature)
7. 创建Pull Request

代码风格指南

• 使用2空格缩进
• 使用有意义的变量和函数名
• 注释您的代码,特别是复杂的逻辑部分
• 遵循JavaScript Standard Style

测试

目前,QRify没有自动化测试套件。我们依赖于手动测试。在提交代码前,请确保:

1. 您的更改不会破坏现有功能
2. 新功能在不同的网页上都能正常工作
3. 扩展在Chrome的不同版本上都能正常运行

文档

如果您的更改涉及用户可见的功能,请确保更新README.md文件。如果您添加或更改了API,请更新相关的代码注释。

问题解答

如果您有任何问题或需要帮助,可以:

1. 查看已有的GitHub Issues,看是否有人遇到过类似问题
2. 创建新的Issue寻求帮助
3. 发送邮件至[email protected]

再次感谢您的贡献!我们期待您的参与,一起让QRify变得更好。