En Adoptium queremos ayudar a la gente a adentrarse en el OpenSource, Java y la Comunidad Java. Por lo tanto, es muy importante para nosotros proporcionar ayuda a las personas que quieren empezar a trabajar en código abierto.
|
Esta documentación es todavía un trabajo en progreso y algunos puntos mencionados son ideas para el futuro que aún no se han establecido. |
Adoptium proporciona varios problemas (issues) que están etiquetados como good first issue. Todos estos problemas son perfectos para empezar a trabajar en un proyecto de código abierto. Los problemas proporcionan descripciones amigables para el usuario y muchos enlaces útiles a documentación y tutoriales para empezar a trabajar directamente en dicho problema. Incluso si no estás muy familiarizado con GitHub en general, los problemas enlazan a tutoriales amigables que ayudarán a los usuarios a entender los flujos de trabajo de forks y pull requests.
Puedes encontrar un ejemplo de un good first issue en el repositorio IcedTea-Web.
En GitHub puedes encontrar una lista de todos los problemas etiquetados como good first issue.
Plantillas
Actualmente estamos trabajando en una plantilla para problemas que están etiquetados como good first issue. La versión actual de la plantilla de problema y una sección sobre "Soporte para primeros pasos" para archivos contributing.md están actualmente en desarrollo.
Flujo de trabajo para crear "good first issues"
Siempre que asumas que un problema podría ser un good first issue, deberías etiquetarlo con la etiqueta good first issue - candidate.
Al hacerlo, puede ser revisado y modificado para convertirse en un good first issue.
En GitHub puedes encontrar una lista de todos los problemas etiquetados como good first issue - candidate.
Todos los problemas etiquetados como good first issue - candidate deben ser revisados y tal vez refactorizados para convertirse en problemas etiquetados como good first issue.
Aquí se deben aplicar las siguientes reglas:
-
El título del problema debe especificar el problema.
-
La descripción del problema debe basarse en nuestra plantilla
good first issue. -
El problema no debe contener ningún comentario. Los comentarios hacen que sea más difícil de entender para un novato. Toda la información relevante que esté en los comentarios debe añadirse a la descripción del problema. Los comentarios deben eliminarse después. Si esto no es posible, la mejor solución es crear un nuevo problema para el good first issue, enlazarlo al original y cerrar el original.
-
Al definir la descripción del problema, siempre tiene sentido enlazar a documentación o archivos útiles (tal vez incluso directamente al código) para ayudar a un recién llegado a encontrar el punto de partida correcto para trabajar en el problema.
Una vez que el problema es refactorizado y revisado, debe etiquetarse como good first issue y la etiqueta good first issue - candidate debe eliminarse.
Además de esto, deberíamos etiquetar todos estos problemas con help wanted y Hacktoberfest.
