chore: update CONTRIBUTING

This commit is contained in:
Junyan Qin
2025-05-20 09:39:46 +08:00
parent 0afef0ac0f
commit ff335130ae

View File

@@ -5,22 +5,27 @@
### 贡献形式 ### 贡献形式
- 提交PR解决issues中提到的bug或期待的功能 - 提交PR解决issues中提到的bug或期待的功能
- 提交PR实现您设想的功能请先提出issue与者沟通) - 提交PR实现您设想的功能请先提出issue与项目维护者沟通)
- 优化代码架构,使各个模块的组织更加整洁优雅
- 在issues中提出发现的bug或者期待的功能
- 为本项目在其他社交平台撰写文章、制作视频等 - 为本项目在其他社交平台撰写文章、制作视频等
- 为本项目的衍生项目作出贡献,或开发插件增加功能 - 为本项目的衍生项目作出贡献,或开发插件增加功能
### 如何开始 ### 沟通语言规范
- 加入本项目交流群,一同探讨项目相关事务 - 在 PR 和 Commit Message 中请使用全英文
- 解决本项目或衍生项目的issues中亟待解决的问题 - 对于中文用户issue 中可以使用中文
- 阅读并完善本项目文档
- 在各个社交媒体撰写本项目教程等
### 代码规范 <hr/>
- 代码中的注解`务必`符合Google风格的规范 ## Guidelines
- 模块顶部的引入代码请遵循`系统模块``第三方库模块``自定义模块`的顺序进行引入
- `不要`直接引入模块的特定属性,而是引入这个模块,再通过`xxx.yyy`的形式使用属性 ### Contribution
- 任何作用域的字段`必须`先声明后使用,并在声明处注明类型提示
- Submit PRs to solve bugs or features in the issues
- Submit PRs to implement your ideas (Please create an issue first and communicate with the project maintainer)
- Write articles or make videos about this project on other social platforms
- Contribute to the development of derivative projects, or develop plugins to add features
### Spoken Language
- Use English in PRs and Commit Messages
- For English users, you can use English in issues