Add instructions how to build the samples

Aperta
#188 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
2/5
Tempo stimato
1-3 ore
Idoneità per principianti
55/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Stack tecnologico
java, shell
Ambito
documentation

Direzione di ricerca

Inizia da README.md e readme.html, poi esamina gli script shell forniti e la struttura di esempio, prestando particolare attenzione a come devono essere disposti i file in target e a come viene utilizzato Maven. Il lavoro è completato quando un nuovo collaboratore può compilare gli esempi, capire se sono standalone e individuare eventuali dipendenze tra moduli che potrebbero dover essere disponibili nel repository Maven locale.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

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.

Lingua principale
Java
Stelle
558
Fork
599
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Preparare l'ambiente

  • Nessun Dockerfile né file Docker Compose
  • Ha un modello di pull request
  • Nessuna guida per i contributori

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di hazelcast/hazelcast-code-samples

Tutte le issue di hazelcast/hazelcast-code-samples

Issue simili

Altre issue su Java

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.