[Community] RocketMQ Studio: AI-Native Management Platform - Call for Contributors
- Dominant language
- Java
- Stars
- 22.6k
- Forks
- 12k
- Avg merge
- 3d 1h
- Merged PRs (30d)
- 27
Description
# RocketMQ Studio 社区共建招募
## 项目简介
**RocketMQ 5.0 Studio:全新的 AI-Native 管控平台**
RocketMQ 5.0 新增了云原生弹性架构、多语言 gRPC 接入,Lite Topic 等核心特性,完成了向 AI-Native 异步通信引擎的范式升级。欢迎贡献全新的 AI-Native 的管控平台,由于任务较为复杂,本次主题将拆分为三个部分:AI-Native 统一管控平台, Proxy Admin 管控能力升级,大模型原生集成。
- **赛道一:管控方向(AI-Native 统一管控平台)**:打造 RocketMQ 5.0 Studio 核心可视化前后端服务,一站式实现多集群、多架构、多云环境的统一管控,为消息中间件管理树立 AI-Native 新标杆。
- **赛道二:协议升级(Proxy Admin 管控能力升级)**:构建 Proxy Admin gRPC 协议标准,将客户端连接管理与运行时诊断能力全面标准化开放,为精细化运维提供坚实底座。
- **赛道三:AI Native(大模型原生集成)**:借助 Skill + CLI 标准化能力封装,资源管理与运维操作可被 LLM 直接理解与调用,为 AI-Native 新时代的消息管控平台提供强劲引擎。
基于此,RocketMQ 社区期望实现 "跨集群、跨架构、跨云的统一管控" 的愿景。
**技术栈**:
- 后端:Spring Boot 3.5 + Java 21
- 前端:React 18 + TypeScript + Ant Design
- 部署:Docker + Docker Compose
📖 **项目文档**:[README_zh.md](https://github.com/apache/rocketmq-dashboard/blob/rocketmq-studio/README_zh.md)
## 活动报名
本项目已入选 **太乙开源挑战赛**,欢迎通过官方渠道报名参与:
🔗 **报名链接**:https://www.taiyi.top/competition-details?id=2f410866-6fa3-11f1-b193-02420a000011
## 贡献说明
### 注意事项
📏 控制 PR 粒度
单个 Pull Request 不应过大,建议修改文件数保持在 5-10 个以内。过大的 PR 会显著增加 Reviewer 的审查负担并延长合并周期,若改动较多请合理拆分为多个原子化 PR。
🏷️ 统一标题前缀
所有与本项目相关的 Issue 和 PR 标题均须以 [studio] 开头,以便社区快速识别、过滤与追踪。例如:[studio] feat: add cluster overview page 或 [studio] fix: consumer group list pagination error。
🎯 赛道一:管控平台贡献准则
该赛道聚焦前端可视化与后端管控服务,每个贡献应围绕将单个页面的功能修改正确为最小完整单元。避免在一个 PR 中混杂多个页面的改动或跨模块的非关联重构,确保每次提交都可独立验证、独立回滚。
💬 赛道二 & 赛道三:先讨论后开发
Proxy Admin 协议升级与大模型原生集成涉及底层架构设计与接口契约变更,请勿直接提交 PR。必须先发起 Issue 详细描述设计方案、协议定义或 Skill 规范,经过社区充分讨论并达成共识后,方可开始编码并提交相关 PR。未经讨论直接提交的 PR 可能因方向偏差被要求大幅返工或关闭。
✅ 提交前自查清单
- PR 标题是否以 [studio] 开头?
- 修改文件数是否控制在 5-10 个以内?
- 赛道一改动是否仅聚焦于单个页面的功能完整性?
- 赛道二/三是否已提前发起 Issue 并获得社区确认?
- 是否已补充必要的单元测试 / E2E 测试?
### Apache 贡献声明
RocketMQ Studio 是 Apache RocketMQ 项目的子项目。参与本项目的贡献,你将成为 Apache 顶级项目的 Contributor,贡献记录永久保存在 Apache 项目历史中,并有机会成为 Apache RocketMQ 的 Committer。
### 贡献类型
我们欢迎各类贡献:
| 类型 | 说明 | 难度 |
|------|------|------|
| 🐛 Bug 修复 | 修复已知问题 | ⭐ ~ ⭐⭐⭐ |
| ✨ 新功能 | 开发新特性 | ⭐⭐ ~ ⭐⭐⭐ |
| 📚 文档 | 完善文档和教程 | ⭐ |
| 🎨 UI 优化 | 改进界面设计 | ⭐⭐ |
| 🧪 测试 | 增加测试覆盖 | ⭐⭐ |
| 🔧 重构 | 优化代码质量 | ⭐⭐⭐ |
### 快速开始
1. **Fork 并克隆仓库**
```bash
git clone https://github.com/YOUR_USERNAME/rocketmq-dashboard.git
cd rocketmq-dashboard
git checkout rocketmq-studio
```
2. **启动开发环境**
```bash
# 后端
cd server && mvn spring-boot:run
# 前端(新终端)
cd web && npm install && npm run dev
```
3. **选择 Issue 开始贡献**
- 查看带 `good first issue` 标签的入门任务
- 查看带 `help wanted` 标签的待开发任务
- 在 Issue 下留言表达参与意愿
## 开发规范
### 提交规范
https://github.com/apache/rocketmq-dashboard 项目使用 [Conventional Commits](https://www.conventionalcommits.org/) 格式:
```
type: description
feat: 新功能
fix: 修复 Bug
docs: 文档更新
refactor: 代码重构
test: 测试相关
chore: 构建/工具
```
### 代码规范
**后端 (Java)**:
- 遵循 Apache RocketMQ Checkstyle 规范
- 运行 `mvn checkstyle:check` 检查
- POJO 类使用 DTO/VO 后缀命名
**前端 (TypeScript)**:
- 运行 `npm run lint` 检查
- 使用函数式组件 + Hooks
- 遵循 Ant Design 设计规范
### PR 流程
相关的 ISSUE 和 PR 请加上 [studio] 表示和本贡献专项进行关联
1. 从 `rocketmq-studio` 分支创建功能分支
2. 开发并确保测试通过(`mvn test` / `npm run lint`)
3. 提交 PR 到 `apache/rocketmq-dashboard` 的 `rocketmq-studio` 分支
4. 等待 Code Review 并响应反馈
5. Review 通过后由 Committer 合并
## 沟通渠道
- **GitHub Issues**:问题反馈和功能讨论
- **邮件列表**:dev@rocketmq.apache.org
- 特别渠道:可通过报名链接下的邮箱与我取得联系,协助完成 issue 和 pr
---
期待你的加入!🚀
---
# RocketMQ Studio Community Call for Contributors
## Introduction
**RocketMQ 5.0 Studio: A Brand New AI-Native Management Platform**
RocketMQ 5.0 introduces cloud-native elastic architecture, multi-language gRPC access, Lite Topic and other core features, completing the paradigm upgrade to an AI-Native asynchronous communication engine. We invite you to contribute to the brand new AI-Native management platform. Due to the complexity of the task, this theme is divided into three parts: AI-Native Unified Management Platform, Proxy Admin Management Capability Upgrade, and Large Model Native Integration.
- **Track 1: Management (AI-Native Unified Management Platform)**: Build the core visualization frontend and backend services of RocketMQ 5.0 Studio, achieving one-stop unified management of multi-cluster, multi-architecture, and multi-cloud environments, setting a new AI-Native benchmark for message middleware management.
- **Track 2: Protocol Upgrade (Proxy Admin Management Capability Upgrade)**: Build the Proxy Admin gRPC protocol standard, fully standardize and open client connection management and runtime diagnostic capabilities, providing a solid foundation for refined operations.
- **Track 3: AI Native (Large Model Native Integration)**: With Skill + CLI standardized capability encapsulation, resource management and operations can be directly understood and invoked by LLM, providing a powerful engine for the AI-Native era message management platform.
Based on this, the RocketMQ community aims to realize the vision of "unified management across clusters, architectures, and clouds".
**Tech Stack**:
- Backend: Spring Boot 3.5 + Java 21
- Frontend: React 18 + TypeScript + Ant Design
- Deployment: Docker + Docker Compose
📖 **Project Documentation**: [README.md](https://github.com/apache/rocketmq-dashboard/blob/rocketmq-studio/README.md)
## Registration
This project has been selected for the **Taiyi Open Source Challenge**. Welcome to register through the official channel:
🔗 **Registration Link**: https://www.taiyi.top/competition-details?id=2f410866-6fa3-11f1-b193-02420a000011
## Contribution Guide
### Apache Contribution Statement
RocketMQ Studio is a subproject of Apache RocketMQ. By contributing to this project, you will become a Contributor to an Apache top-level project, your contributions will be permanently recorded in the Apache project history, and you will have the opportunity to become a Committer of Apache RocketMQ.
### Contribution Types
We welcome all kinds of contributions:
| Type | Description | Difficulty |
|------|-------------|------------|
| 🐛 Bug Fix | Fix known issues | ⭐ ~ ⭐⭐⭐ |
| ✨ New Feature | Develop new features | ⭐⭐ ~ ⭐⭐⭐ |
| 📚 Documentation | Improve docs and tutorials | ⭐ |
| 🎨 UI Enhancement | Improve interface design | ⭐⭐ |
| 🧪 Testing | Increase test coverage | ⭐⭐ |
| 🔧 Refactoring | Optimize code quality | ⭐⭐⭐ |
### Quick Start
1. **Fork and clone the repository**
```bash
git clone https://github.com/YOUR_USERNAME/rocketmq-dashboard.git
cd rocketmq-dashboard
git checkout rocketmq-studio
```
2. **Start the development environment**
```bash
# Backend
cd server && mvn spring-boot:run
# Frontend (new terminal)
cd web && npm install && npm run dev
```
3. **Choose an Issue to start contributing**
- Check issues labeled with `good first issue` for beginners
- Check issues labeled with `help wanted` for development tasks
- Comment on the issue to express your interest
## Development Guidelines
### Commit Convention
Use [Conventional Commits](https://www.conventionalcommits.org/) format:
```
type: description
feat: new feature
fix: bug fix
docs: documentation update
refactor: code refactoring
test: test related
chore: build/tools
```
### Code Standards
**Backend (Java)**:
- Follow Apache RocketMQ Checkstyle rules
- Run `mvn checkstyle:check` to verify
- Use DTO/VO suffix naming for POJOs
**Frontend (TypeScript)**:
- Run `npm run lint` to verify
- Use functional components + Hooks
- Follow Ant Design specifications
### PR Process
1. Create a feature branch from `rocketmq-studio`
2. Develop and ensure tests pass (`mvn test` / `npm run lint`)
3. Submit PR to the `rocketmq-studio` branch of `apache/rocketmq-dashboard`
4. Wait for Code Review and respond to feedback
5. Review approved, merged by Committer
## Communication Channels
- **GitHub Issues**: Bug reports and feature discussions
- **GitHub Discussions**: Community交流
- **Mailing List**: dev@rocketmq.apache.org
---
Looking forward to your participation! 🚀
Contributor guide
Research direction
Read README_zh.md or README.md, then inspect the server and web entry points on the rocketmq-studio branch; the issue provides mvn spring-boot:run and npm run dev as starting commands. Select and clarify one management, Proxy Admin, or AI-native track with the community first, because this issue has no single implementation scope or acceptance criterion.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- docker, docker-compose, grpc, java, react, spring-boot, typescript
- Domain
- cloud, devops, full-stack
- Issue type
- Feature
- Difficulty
- 5/5
- Estimated time
- Over a week
- Activity status
- Quiet
- Clarity
- Needs clarification
- Newbie friendliness
- 25/100