Add examples
Abierto
Nadie ha tomado este issue todavía.
good first issue
help wanted
- Lenguaje dominante
- Java
- Estrellas
- 71
- Forks
- 44
- Merge medio
- 12 h 54 min
- PR fusionados (30 d)
- 7
Descripción
It would help first time users to create some examples for common library usage.
Some ideas for different examples:
- Creating a document, adding a few files using the SPDX Model Factory
- Parsing license expressions using the SPDX license parser
- Comparing SPDX documents using the SPDX Document Comparer
Guía de contribución
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comienza con los puntos de entrada vinculados SpdxModelFactory.java, LicenseInfoFactory.java y SpdxComparer.java para entender los tres flujos de trabajo propuestos. Añade ejemplos ejecutables para crear un documento y archivos, analizar expresiones de licencia y comparar documentos SPDX; se considerará terminado cuando se demuestren claramente los tres usos habituales de la biblioteca para quienes la usan por primera vez.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- java
- Área
- documentation
- Tipo de issue
- Documentación
- Dificultad
- 3/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 35/100