Malagu 贡献指南

[CoreyBin]

Malagu 贡献指南

欢迎来到开源摘星计划 - Malagu 贡献专栏 。Malagu 已加入开源摘星计划，该计划提供奖励以鼓励你加入我们的社区：所有参与本项目贡献的开发者都可获得相应贡献积分、奖励以及被评选为年度摘星100 人的机会，活动及奖励详情请见：开源摘星计划。

📅活动时间：2022年5月-12月

🌟关于Malagu

Malagu 是基于 TypeScript 的 Serverless First、组件化、平台无关的渐进式应用框架。

支持 15+ 框架

目前 Malagu 生态包含了 Malagu Cli 和 Malagu Framework，其中，Malagu Cli 已支持如下框架和工具，可以享受 Malagu 带来的开发和部署的便利:

什么是 Malagu

Malagu 是基于 TypeScript 的 Serverless First、组件化、平台无关的渐进式应用框架。Malagu 是首款 Serverless First 应用开发框架。使用同一套编程语言和 IoC 设计，用于开发前端、后端和前后端一体化应用。并且结合了 OOP（面向对象编程）、AOP（面向切面编程）等元素，借鉴了很多 Spring Boot 设计思想。

在后端，Malagu 抽象一套接口，方便适配任意的平台和基础框架，是一个平台或基础框架无关的上层框架。平台如阿里云函数计算、腾讯云函数、AWS Lambda、Vercel 等，基础框架如 Express、Koa、Fastify 等。

在 Serverless 场景，Malagu 是以应用为单位开发项目，一个应用一般包含多个 API 接口。如果我们的应用很大，我们应该将大应用拆解成一个个小的微应用或者微服务。就像微服务架构的粒度拆分原则一样，合理的粒度拆分，对我们的应用管理是有很多好处的。框架会保证一个应用在一个函数中的运行性能。

Malagu 架构图

以下是项目可参与的方向：

1. 我们列出了适合首次加入 Malagu 社区的贡献者的问题、适合对项目有足够了解的贡献者的特殊 issue 挑战（参见下面的列表）以及一些社区日常任务。如果你愿意解决，请点击该 issue 并在评论区留言“WeOpen Star”（日常及其他任务无需此操作）。提交 PR 时，请同时将 PR 链接到相应的 issue。

2. 对于成功完成任意任务的贡献者，为记录你的积分以及发放奖励，请自行前往你的积分主页记录。积分记录规则详见：关于积分。

在开始贡献之前：

• 请加入【开源摘星计划】社群

  请添加官方小助手微信（微信号：TCOSOO1）

• 对本项目感兴趣的同学可参照下方二维码，扫码进入官方交流群

🌟我们对贡献任务进行了分类，以帮助你找到你感兴趣的任务

社区日常任务

积分奖励：1分/个

• 参与项目例会
• 提交 Issue/Comment

文档类

积分奖励：10分/篇

文档目前以理论为主，希望可以以篇为维度，从操作实践角度进行完善。
文档地址：https://malagu.cellbang.com

• 教程 - 常见问题: 可以在官方群收集用户常见问题，即时补充进入文档
• 教程 - 认证和授权: 可以补充使用实例

编程类

积分奖励：50分/个

请求支撑后端地图接口对接
使用框架实现出对接常用地图api的示例，如 高德地图，百度地图。
难度： 低

请求支持推送相关
使用框架实现出常用的推送平台的对接示例，如 腾讯极光push等。
难度： 低

提供自动生成命令创建微服务项目的模块
拓展框架现有的命令行，支持通过命令行创建微服务模块
难度： 中

以及其他任何觉得可以完善的部分，可以自主提交 Issue 后编程实现

其他类

开源知识分享官：提交对本项目的学习笔记或开源相关笔记（视频/文章皆可）并发布在任意社区/博客/视频平台即可申报积分。

积分奖励：10分

额外奖励：每月将为10名优秀笔记作者奖励QQ周边公仔、QQ音乐/腾讯视频年卡及腾源会T恤等好礼。

贡献帮助

对本项目感兴趣，或者需要帮助的朋友可以扫描下方二维码加入 Malagu 官方微信交流群