代码规范
提交项目代码需要满足以下规范,以确保提供的项目确保项目质量。
开源规范
代码托管平台
GitHub、码云、Coding、微信开发者代码管理等
开源许可证
本次征集不限制项目的具体许可证。如果您没有明确选择,我们推荐您选择 Apache LICENSE 、MIT LICENSE 等常用许可证。
项目必备文件
- README.md: 项目的介绍
- LICENSE: 项目的开源许可证
- code-of-conduct.md: 项目的行为准则
- contributing.md: 项目的贡献指南
- deployment.md: 部署说明
- changelog.md: 项目的更新日志
README 规范
README 中需要包含以下内容:
- 项目名称
- 项目介绍
- 项目效果截图(4-6张),能体现核心功能,不需要套壳;
- 项目体验小程序二维码或者链接(如果已经上线)
- 部署教程
- 开源许可证标注
部署教程规范
必要因素
从实践的角度来看,推荐你在部署教程中至少包含以下因素
- 如何下载代码
- 如何将代码导入到开发者工具
- 哪些参数需要修改
- 哪些云函数需要部署
- 涉及到的外部服务
- 云数据库中需要创建哪些数据
- 云存储中需要上传哪些文件
- 后台需要配置哪些服务
非必要因素
从实践的角度来看,建议你至少提供以下信息,便于用户使用你的小程序模板
- 数据维护指南
- 联系方式
交付格式
推荐使用 PDF / 视频作为部署教程的交付格式
这不太好吧 ,我们自己写的代码还要开源?给你们看看可以,但是开源。伸手党那么多,也没人给报酬 啊 。
本着学习小程序的心态来开发一款商业用途的项目,顺便来参赛,居然强制开源。。我看还是算了 不参加比赛了
事情太多了,哎
这意思是,要参赛就要把整个项目完全公开?还带部署教程?
直接建成 小程序开源库啊 估计不会有什么好东西
应该可以放私有库里面把,不一定放公开库