Unify the execution in code-samples

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

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

評価

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

調査の方向性

まず readme.html を確認し、既存のサンプルディレクトリ、bash スクリプト、欠落している README ファイルを一覧化します。次に、提案されている Maven exec-plugin アプローチを含め、各サンプルが現在どのように実行されているかを比較し、その後、一貫した Windows 対応の手順セットを定義して、すべてのサンプルに利用可能な main クラスが記載されていることを確認します。

索引モデルが issue の本文から書いたものです。

説明

enhancement

Find a way to unify how the code samples are executed.

There are some general instructions for executing samples in the readme.html, but they are not sufficient for all user kinds. They are targeting advanced/experienced users.

What can go wrong with current structure:

  • it's confusing when some samples have bash scripts included and other don't have
  • samples don't have Windows scripts, it can look like it's targeting just a Un*x audience

Suggestion to improvement:
Avoid using shell scripts and provide README files for all samples.
The READMEs could do the better job than the bash scripts. They should work for Windows users too.

Another improvement could be to employ maven exec plugin, so users would do just mvn java:exec. There still would be a need to list the main classes available in the sample in the README.

This issue is related to #188 (instructions how to build the samples).

主要言語
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 を短くまとめたダイジェスト。