Simplify and unify hazelcast-code-samples

Aperta
#199 1 commento 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
20/100
Tipo di issue
Refactoring
Chiarezza
Da chiarire
Stato di attività
Ferma
Stack tecnologico
java, shell

Direzione di ricerca

Iniziare esaminando i 214 moduli di esempio, le relative 312 classi principali, gli script shell e la configurazione del POM parent. Confrontare il modo in cui gli esempi vengono avviati e arrestati, quindi valutare quali candidati potrebbero essere unificati o rimossi. Il risultato proposto è un insieme di esempi più piccolo e denominato in modo coerente, eseguibile tramite maven-exec-plugin e adatto alla verifica con Jenkins, ma l’issue non identifica file o test specifici.

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

Descrizione

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.

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.