参与开发
我们热切期待您成为 elsfs 开源生态的重要构建者!无论您是经验丰富的开发者还是刚入门的新手, 这里都是您施展才华的舞台。加入我们,携手打造行业领先的微服务解决方案, 让您的代码改变成千上万开发者的工作方式!
为什么选择参与 elsfs 开发?
代码贡献:从 Good First Issue 开始,逐步深入核心模块开发文档优化:完善使用手册、编写技术博客、录制教学视频质量护航:参与代码审查、编写单元测试、进行漏洞排查生态建设:开发 IDE 插件、制作技术主题分享、撰写项目集成案例社区支持:解答用户问题、完善 Issue 模板、维护知识库
每一行代码都值得被尊重,我们为所有贡献者准备了阶梯式成长路径。 从基础贡献者到核心 committer,您的成长将获得全程见证与支持!
贡献流程
1. Fork 仓库
第一步:Fork 代码仓库
浏览器访问:https://gitee.com/jglab/elsfs-cloud 点击 Fork 按钮,创建自己的仓库。
注意
Fork 操作会在您的 Gitee 账号下创建 elsfs-cloud 项目的副本,您可以在此副本上自由开发
2. Clone 仓库
第二步:Clone 本地仓库 使用以下命令将代码克隆到本地:
shell
git clone https://gitee.com/{您的用户名}/elsfs-cloud.git注意: 确保已安装 Git 并配置好 Gitee 的 SSH key 或用户名密码
完成后进入项目目录:
shell
cd elsfs-cloud添加上游仓库,便于同步最新代码:
shell
git remote add upstream https://gitee.com/jglab/elsfs-cloud.git3. 开发提交
第三步:修改并提交代码
⚠️:请确保您的代码遵循项目规范并经过充分测试
开发前同步最新代码:
shell
git fetch upstream
git checkout mian
git merge upstream/mian创建并切换到新分支进行开发:
shell
git checkout -b feature/your-feature-name修改代码后; 确保代码符合项目规范
shell
# 运行代码规范检查
./gradlew spotless:apply -P check
# 运行代码风格检查
./gradlew checkstyle:check -P check修改代码后,提交到您的本地仓库:
shell
git add .
git commit -m "feat: 添加新功能描述"推送到您的远程仓库:
shell
git push origin feature/your-feature-namecommit 信息请遵循规范:
- feat: 新功能
- fix: 修复 bug
- docs: 文档变更
- style: 代码格式调整
- refactor: 代码重构
- perf: 性能优化
- test: 测试用例相关
- build: 构建系统或依赖相关
4. 创建/提交 Pull Request
第四步:创建 Pull Request
在您的远程仓库中,创建 Pull Request, 将您的修改提交 Pull Request 至我们的 main 分支。
⚠️:提交 PR 前请确认:
- 代码已经过本地完整测试
- 无明显冲突
- 代码符合项目规范