Simplify and unify hazelcast-code-samples

未关闭
#199 1 条评论 0 个 reaction 已指派 0 人 在 GitHub 查看

还没有人认领这个 Issue。

评估

难度
5/5
预计耗时
一周以上
新手友好度
20/100
Issue 类型
重构
描述清晰度
需要澄清
活跃度
停滞
技术栈
java, shell

调研方向

首先检查 214 个示例模块、它们的 312 个主类、Shell 脚本以及父 POM 配置。比较示例的启动和关闭方式,然后考虑哪些候选项可以统一或移除。拟议的结果是一个更小且命名一致的示例集,可通过 maven-exec-plugin 运行,并适合 Jenkins 验证,但该 issue 未指出具体的文件或测试。

由索引模型根据 Issue 内容生成。

描述

enhancement

I would like to open discussion about simplifying and unifying code samples. The idea behind is to provide unified experience to users and allow QE to verify the samples in a CI job.

Suggested improvements:

  • use one main class per sample and unify its name across the samples (e.g. Main.java), so the maven-exec-plugin can be configured in the parent POM and users can use mvn exec:java in each sample
  • shut down the whole cluster at the end of each sample
  • remove shell scripts - the maven-exec-plugin shall be used instead (lets provide README.md where necessary)
  • use System.out to print what the samples do
    • it will allow to introduce basic test automation in Jenkins

We should also think about slimming down the samples - i.e. find candidates for a removal. We have 214 modules with 312 main classes included now. Such amount is not easy to maintain. I would prefer to have 100 main classes at most.

Comments and suggestions for other improvements are welcome.

主要语言
Java
星标
558
派生
599
PR 合并指标
30 天内没有已合并 PR

环境准备

  • 没有 Dockerfile 或 Docker Compose 文件
  • 有 Pull Request 模板
  • 没有贡献指南

从这里开始

  1. 先读完整个 Issue,再读项目的贡献指南。
  2. 在 Issue 下留言说明你要接手 —— 这能避免两个人做同样的事。
  3. Fork 仓库,在一个分支上完成修改。
  4. 提交 Pull Request,并在描述里引用这个 Issue 编号。

hazelcast/hazelcast-code-samples 的其他 Issue

查看 hazelcast/hazelcast-code-samples 的全部 Issue

相似的 Issue

更多 Java Issue

把新 issue 发到你的邮箱

精选适合新手参与的 GitHub issue 摘要。