Lineamientos de envío de productos de trabajo

Como parte de la evaluación final, todos los colaboradores que participen deben proporcionar un vínculo al trabajo que realizaron para el programa. De lo contrario, es posible que se rechace el programa. Hay varias formas diferentes de hacerlo, así que lee este documento con atención.

Estos vínculos se publicarán en el archivo público de los proyectos de GSoC. Ayudan a demostrar el trabajo realizado durante el programa. También son una excelente manera de consultar tu trabajo para futuros empleadores. El objetivo es que las personas puedan comprender rápidamente cuáles fueron los objetivos de tu proyecto, qué lograste, dónde está tu código y los posibles pasos a seguir.

Los mejores ejemplos que hemos visto en años anteriores parecen un "informe final" que contiene lo siguiente:

  • Una breve descripción de los objetivos del proyecto.
  • Lo que hiciste.
  • Es el estado actual.
  • Qué falta hacer
  • El código que se combinó (o no) en sentido ascendente
  • Cualquier desafío o cosa importante que aprendiste durante el proyecto.

Para ver ejemplos, comienza con la lista de proyectos de 2022, elige proyectos de forma aleatoria y, luego, haz clic en VER CÓDIGO. Ten en cuenta que muchos de estos proyectos no siguieron nuestras sugerencias, lo que significa que solo los perjudicaron porque pueden mostrar su trabajo.

NOTA AL COLABORADOR: Una vez que envíes tu trabajo final, puedes editarlo hasta la fecha límite final para el envío de tu trabajo.

Debes compartir tu enlace con tu mentor ANTES de enviar tu evaluación para asegurarte de que cumpla con sus expectativas.

Requisitos

  • Debe ser fácil identificar el trabajo que has hecho. (es decir, los cambios que realizaste o el código nuevo).
    • Cuando alguien vaya a la URL proporcionada, debería quedar claro qué trabajo hiciste sin necesidad de que realice una investigación adicional significativa.
  • Debe estar en una ubicación estable. La URL no se puede cambiar después del envío.
  • Otra persona debería poder usar el contenido que se encuentra en el destino del vínculo (o en el que se hace referencia) para extender tu trabajo.
    • Si tu trabajo está 100% completo, deberían poder usarlo.
    • Si tu trabajo no está completo, debería quedar claro lo que queda por hacer.

Ejemplos que debes seguir

No tienes que realizar todas estas acciones (ni ninguna), pero estas son algunas formas de cumplir con los requisitos.

  • Crea una entrada de blog, una página web o un gist público de GitHub que describa el trabajo que realizaste y vincule a las confirmaciones que realizaste y a los repositorios en los que trabajaste. Si aún hay trabajo por hacer en el proyecto, inclúyelo también. También puedes compartir elementos destacados o piezas desafiantes.
    • ❗ Esta es la mejor opción porque te permite incluir fácilmente mucha información. Esto es bueno porque te mostrará con claridad el trabajo que hiciste y facilitará que otros usen y entiendan tu código.
  • Si usas GitHub y todo tu trabajo está cubierto por una sola solicitud de extracción, puedes usar ese vínculo.
    • Asegúrate de que la descripción de la solicitud de extracción esté detallada. (Consulta las sugerencias de contenido para entradas de blog más arriba).
    • Asegúrate de que la descripción indique claramente que esto es para Google Summer of Code.
    • Si la solicitud de extracción tendrá más trabajo después de que GSoC finalice, asegúrate de que se anota la última confirmación de GSoC.
    • ❗ Este ejemplo tiene el beneficio de tener el registro de cambios, una lista de confirmaciones y los comentarios de opiniones, todo en un solo lugar.
  • Si tu repositorio de GitHub es de un solo propósito para GSoC, agrega un archivo README.md con más detalles.
  • Envía un correo electrónico a la lista de distribución de desarrolladores archivada de forma pública, con lo anterior, y un vínculo a ella también.
  • Crea una carpeta pública en Google Drive y, luego, incluye todos los parches que creaste.
  • Crear una hoja de cálculo pública con Hojas de cálculo de Google y enumerar todas tus confirmaciones
  • Establece un vínculo a un solo error que contenga claramente referencias al trabajo y cualquier otra cosa adecuada. Debería hacer un seguimiento de todo el trabajo que realizaste. Asegúrate de que enumere todas las confirmaciones o de que sea fácil encontrarlas.
  • Incluye un vínculo a una diferencia unificada o de contexto de tus cambios. Asegúrate de incluir un encabezado que indique para qué proyecto es y quién eres, por lo que será útil para los demás.

Ejemplos que debes evitar

No hagas esto.

  • Vínculo a un archivo tarball o ZIP que contenga el código fuente de todo el proyecto o tu directorio de trabajo. (Demasiadas personas han hecho esto en el pasado, no es útil para quienes quieran entender más sobre lo que tú hiciste).
  • Vínculo a la parte superior del repositorio de código fuente principal del proyecto.
  • Vínculo a tu clonación del repositorio de código fuente del proyecto.
    • Esto hace que sea difícil ver cuáles son tus cambios porque tu trabajo se mezcla con otros.
  • Vínculo a la página del proyecto de GSoC.
    • Ya sabemos de qué se trata (p. ej., https://summerofcode.withgoogle.com/projects/#1234567890).

Mentores

Ayuda a tu colaborador a enviar un código de forma correcta. Es importante hacerlo antes del período final de envío de trabajos.

Comprobar que...

  • El envío cumple con los requisitos anteriores.
  • El código se compila.
  • Hay documentación sobre qué y por qué.

La idea de GSoC no es que los colaboradores produzcan código; es importante que el código sea potencialmente útil para el proyecto de código abierto de hosting.