Add instructions how to build the samples

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

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

評価

難易度
2/5
見積もり時間
1〜3時間
初心者へのやさしさ
55/100
issue の種類
ドキュメント
明瞭さ
明確に書かれている
活発さ
停滞
技術スタック
java, shell
領域
documentation

調査の方向性

README.md と readme.html から始め、続いて提供されている shell スクリプトとサンプルのレイアウトを確認します。特に、target 内でファイルがどのように配置されることを想定しているか、また Maven がどのように使用されているかを確認してください。新しく参加する人がサンプルをビルドし、それらが standalone かどうかを理解し、ローカルの Maven リポジトリで利用可能にしておく必要がある可能性のあるモジュール間依存関係を特定できれば完了です。

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

説明

enhancement

Provide more details how to build the code-samples in README.md or readme.html.

It's not obvious how to start with the code samples provided with Hazelcast. It's mainly important for people who didn't met Maven before.

The provided shell scripts don't build the sample themselves, they just expect the bits are ready in target directory.

Interdependencies
There is one more point related: it's not obvious if the samples are standalone or have some interdependecies. So if a user tries just one sample, it can experience dependency problems when another module (dependency) in not already in the local Maven repo.

Mention the possible cross-module dependenices in the readme too.

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