Unify the execution in code-samples

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
25/100
Tipo di issue
Funzionalità
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
java, shell

Direzione di ricerca

Inizia esaminando readme.html e facendo un inventario delle directory di esempio esistenti, degli script bash e dei file README mancanti. Confronta il modo in cui viene attualmente eseguito ogni esempio, incluso l’approccio proposto con Maven exec-plugin, quindi definisci un insieme coerente di istruzioni compatibili con Windows e verifica che ogni esempio documenti le classi main disponibili.

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

Descrizione

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).

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.