Simplify and unify hazelcast-code-samples

オープン
#199 コメント 1 件 リアクション 0 件 担当者 0 名 GitHub で見る

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
20/100
issue の種類
リファクタリング
明瞭さ
説明が足りない
活発さ
停滞
技術スタック
java, shell

調査の方向性

まず、214個のサンプルモジュール、それらの312個のメインクラス、シェルスクリプト、および親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 ファイルなし
  • プルリクエストのテンプレートあり
  • コントリビューションガイドなし

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

hazelcast/hazelcast-code-samples のほかの issue

hazelcast/hazelcast-code-samples の issue をすべて見る

似ている issue

Java の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。