Contribuyendo a Pygame Zero

El proyecto Pygame Zero está alojado en GitHub:

Informar de un error o petición

Puedes reportar errores, o solicitar características que crees que deberían estar en Pygame Zero, utilizando el Github issue tracker.

Aquí hay algunas cosas a tener en cuenta antes de hacer esto:

  • ¡Puede que no seas sólo tú! Deberías comprobar si alguien ya ha reportado el problema buscando en los problemas existentes, tanto abiertos como cerrados.

  • Los desarrolladores necesitan saber qué versión de Pygame Zero estás usando, y qué sistema operativo está ejecutando (Windows, Mac, Linux, etc) y la versión (Windows 10, Ubuntu 16.04, etc).

Cómo hacer un pull request

Puedes hacer cambios en Pygame Zero creando un pull request.

Es una buena idea reportar un issue primero, para que podamos discutir si tu cambio tiene sentido.

Github tiene ayuda sobre cómo crear un pull request, pero aquí está la versión rápida:

  1. Asegúrate de que has iniciado sesión en Github.

  2. Ve a la página de Github para Pygame Zero.

  3. Haz clic en «Fork» para crear tu propio fork del repositorio.

  4. Clona este fork en tu propio ordenador:

    git clone git@github.com:tu_nombre_de_usuario/pgzero.git

    Recuerda cambiar tu nombre de usuario por tu nombre de usuario en Github.

  5. Crea una rama en la que hacer tus cambios. Elige un nombre de rama que describa el cambio que quieres hacer.

    git checkout -b mi-nueva-rama master

  6. Realiza los cambios que quieras.

  7. Añade los archivos que quieras confirmar:

    git add pgzero

  8. Confirme los archivos con un mensaje de confirmación claro:

    git commit -m "Corregido el problema #42 renombrando los parámetros"

    Puedes hacer los pasos 6 a 8 tantas veces como quieras hasta que estés contento.

  9. Empuja el commit a tu fork:

    git push --set-upstream origin mi-nueva-rama

  10. Ve a la página de Github de tu rama y haz clic en el botón «Create pull request». crear una solicitud de extracción.

Instalación de desarrollo

Es posible crear una instalación local con pip. Desde el directorio raíz de la fuente comprobada, ejecutar:

pip3 install --editable .

La versión instalada reflejará ahora cualquier cambio local que hagas.

Alternativamente, si usted no quiere instalarlo en absoluto, se puede ejecutar con:

python3 -m pgzero <nombre del script pgzero>

Por ejemplo:

python3 -m pgzero examples/basic/demo1.py

Cómo ejecutar las pruebas

Las pruebas se pueden ejecutar con

python3 setup.py test

Ayudando a traducir la documentación

Las APIs de Pygame Zero siempre estarán en inglés, pero podemos llevar Pygame Zero a más usuarios de todo el mundo si la documentación está disponible en su idioma.

Si dominas otro idioma, por favor considera contribuir traduciendo toda o parte de la documentación.

La documentación está escrita en reStructuredText, que es un lenguaje de marcado basado en texto para documentación técnica. En la medida de lo posible, se debe conservar el formato existente. reStructuredText no es demasiado difícil una vez que te acostumbras a él.

La creación de una traducción se realiza creando un repositorio separado en Github con una copia de la documentación, reescrita (al menos en parte) en el idioma que se desea apoyar. Una de las ventajas de esto es que puedes trabajar en las traducciones a tu propio ritmo, sin tener que enviar solicitudes de extracción al propio proyecto pgzero. Por favor, consulta la guía de traducción en Read The Docs para más detalles.

Si esto suena como algo que podría abordar, aquí es cómo usted podría ir sobre de hacerlo:

  1. Primero, abre una incidencia en el pgzero issue tracker. Deberías buscar una cuestión existente que cubra la traducción que desea hacer, antes de abrir una una nueva. Esto le ayudará a asegurarse de que no hace un trabajo de traducción que ya ha sido ya ha sido realizado por otra persona (quizás puedas colaborar en su lugar).

  2. Crea un nuevo repositorio de Github bajo tu usuario, llamado pgzero-idioma, por ejemplo pgzero-spanish si vas a traducir al español.

  3. Clona el repositorio en tu propio ordenador.

  4. Descarga el directorio doc/ de Pygame Zero y confírmalo en tu proyecto. Puedes hacerlo extrayéndolos del archivo ZIP del repositorio. Sólo necesitas necesitas el directorio doc/ del archivo ZIP. Puede eliminar los otros archivos.

  5. Ahora, trabaje a través de los archivos .rst en el directorio docs, traduciendo, usando su editor preferido. Deberías hacer commits regularmente, y empujar tus commits a Github.

  6. Publica un enlace a tu repositorio como un comentario en el tema de Github que creaste en el paso 1. Puedes hacer esto tan pronto como tengas algún progreso que mostrar; esto Esto ayudará a la gente a colaborar con usted en la traducción si están interesados.

    1. Configurar la documentación para construir en Read The Docs. De nuevo, publica un comentario en el tema de Github cuando tengas esto funcionando.

  8. Podemos entonces enlazar la nueva documentación traducida con la documentación de Pygame Zero con la documentación de Pygame Zero.

Tenga en cuenta que Pygame Zero tendrá actualizaciones, y la documentación se cambiará en consecuencia. Usando Git es posible ver un diff de lo que cambió en la documentación en inglés, para poder hacer los cambios correspondientes en la documentación traducida.