Unify the execution in code-samples

Abierto
#189 0 comentarios 0 reacciones 0 asignados Ver en GitHub

Nadie ha tomado este issue todavía.

Evaluación

Dificultad
5/5
Tiempo estimado
Más de una semana
Aptitud para principiantes
25/100
Tipo de issue
Nueva funcionalidad
Claridad
Necesita aclaración
Estado de actividad
Estancado
Stack tecnológico
java, shell

Línea de trabajo

Comienza revisando readme.html y haciendo un inventario de los directorios de ejemplo existentes, los scripts de bash y los archivos README que faltan. Compara cómo se ejecuta actualmente cada ejemplo, incluido el enfoque propuesto con Maven exec-plugin, y después define un conjunto coherente de instrucciones compatible con Windows y verifica que cada ejemplo documente sus clases main disponibles.

Escrito por el modelo de indexación a partir del texto del issue.

Descripción

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

Lenguaje dominante
Java
Estrellas
558
Forks
599
Métricas de merge de PR
Sin PR fusionados en 30 d

Preparar el entorno

  • Sin Dockerfile ni archivo de Docker Compose
  • Tiene una plantilla de pull request
  • Sin guía de contribución

Primeros pasos

  1. Lee el issue completo y luego la guía de contribución del proyecto.
  2. Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
  3. Haz un fork del repositorio y trabaja en una rama.
  4. Abre un pull request que haga referencia al número del issue.

Más de hazelcast/hazelcast-code-samples

Todos los issues de hazelcast/hazelcast-code-samples

Issues similares

Más issues de Java

Recibe los nuevos issues en tu correo

Un resumen breve de issues de GitHub para principiantes.