Existen muchas formas de contribuir con Python España. Escribir contenido para la página web, mantener la información contenida actualizada, detectar problemas o corregirlos son formas efectivas de mejorar la comunidad.
Recuerda que, tanto contribuir a este repositorio como administrarlo, supone la aceptación de nuestro código de conducta.
La forma más sencilla de contribuir con la página web es informar de un error detectado. Introduce un título corto y, en el espacio para comentarios, indica la dirección web donde detectaste el problema, y añade una pequeña descripción del mismo. Recuerda que puedes añadir imágenes, como capturas de pantalla, arrastrando la imagen sobre el editor. Por ejemplo:
Dónde pone "title": Hay muy poco espacio entre títulos y contenido
Dónde pone "leave a comment":
En la sección "¡hazte socio!": https://es.python.org/hazte-socio/
Hay muy poco espacio entre los títulos grandes y los subtítulos o contenido
y esto dificulta la lectura.
Si prefieres pasar a la acción, habrás de comenzar creando una cuenta en GitHub. Con ella podrás administrar los archivos del sitio web desde el navegador.
El contenido del sitio web de la asociación se encuentra en el directorio src/content y está escrito en Markdown, lenguaje de marcado sencillo que habrás de utilizar.
Las revisiones por parte del equipo editorial se realizan a través de la web de GitHub y, aunque el procedimiento es bastante intuitivo, habrás de familiarizarte con el procedimiento de revisión.
NOTA: si prefieres tareas más técnicas o editar el proyecto en un equipo local utilizando
git, consulta el README donde se explica cómo descargar, configurar y probar el sitio web.
Explora el repositorio original de la asociación y localiza el artículo o página donde se encuentre el error. Si se trata de un artículo, estará bajo la carpeta content directamente. Si se trata de una página, estará bajo la carpeta templates.
Una vez hayas encontrado el fichero, edita el contenido desde GitHub, corrige el error pertinente y envía el cambio haciendo click en el botón "Propose file change".
Si quieres añadir un artículo, entra en la carpeta src/content/posts y haz click en el botón "Create new file". El nombre del archivo debe tener el formato AAAA-MM-DD-post-slug.md.
Un artículo está compuesto de dos secciones, metadatos (frotmatter) y contenido, separadas por las líneas (---). Los metadatos son obligatorios y sirven para clasificar el artículo. Son los siguientes:
| Clave | Descripción |
|---|---|
| title | Título del artículo |
| date | Fecha de publicación en formato AAAA-MM-DD |
| draft | true/false, dependiendo de si queremos que esté oculto o se muestre |
| image | Ruta a la imagen del artículo, que debería estar dentro de images/posts |
El contenido se ha de escribir utilizando Markdown. Un ejemplo de artículo.
Cuando hayas terminado de editar, haz click sobre el botón "Propose new file".
También deberás subir la imagen a la que hace referencia el campo image de los metadatos.
El proceso para añadir eventos es igual que para añadir un artículo, con la salvedad de subir el Markdown del contenido a src/content/eventos/ y la imagen a images/eventos, con un tamaño de 1080x600px.
Además, los campos de metadatos que tendrás que rellenar son:
| Clave | Descripción |
|---|---|
| title | Nombre del evento |
| date | Fecha de inicio del evento en formato ISO |
| fullDate | Fecha completa con inicio y final, escrita como texto en español |
| featured | true/false, dependiendo de si queremos que se destaque en primera plana o no |
| image | Ruta a la imagen del artículo, que debería estar dentro de images/eventos |
| logo | Ruta al logo del evento, que debería estar dentro de images/eventos. Se mostrará si no existe image y en los eventos featured. |
| description | Texto corto de un párrafo para mostrar como descripción para los eventos featured. |
| website | Enlace a la web del evento |
| draft | true/false, dependiendo de si queremos que esté oculto o se muestre |
El sitio web de la asociación Python España pretende facilitar el acceso a las comunidades locales de Python. Por ello, si conoces una comunidad regional o local que realice actividades relacionadas con el lenguaje, te pedimos que la añadas a nuestro mapa de comunidades.
Para añadir una nueva comunidad necesitarás encontrar su latitud y longitud en el globo, el nombre de la comunidad y la dirección web. Localiza el texto que pone:
const groups = [Y, a continuación, incluye una objecto con el siguiente formato:
{
name: 'Python Vigo',
latitude: 42.19864,
longitude: -8.7726,
web: 'http://www.python-vigo.es/',
twitter: 'https://twitter.com/python_vigo',
telegram: 'https://t.me/joinchat/AAAAAAfW2-q8miOKsVGjCg',
email: '[email protected]',
},
Respeta los corchetes ([ y ]), las comillas simples (') que encierran el nombre de la comunidad y la dirección web; conserva también las comas y la coma tras el corchete de cierre.
No todo es crear contenido. La web también necesita un mantenimiento tanto de de sus capacidades, como de su estructura y diseño. Otra forma de contribuir con el sitio web de la asociación Python España es echando un vistazo a las issues abiertas, escoger una y solucionarla.
Estas tareas son técnicas y es recomendable trabajar en un entorno de desarrollo local, utilizando git para clonar el repositorio. Consulta el README donde se explica cómo descargar, configurar y probar el sitio web.
Uno de los objetivos de este repositorio es que sea accesible y fácil de editar para personas sin perfil técnico. Esta guía, por ejemplo, recoge cómo realizar modificaciones directamente desde la web. Sin embargo el contenido no es perfecto y seguro que hay mejores maneras de explicar algo o cuestiones que podrían aclararse con una imagen.
Mejorar los documentos README.md y CONTRIBUTING.md es también una forma útil de contribuir con la asociación. Utiliza el mismo procedimiento explicado en la sección Editando contenido ya existente para proponer cambios en estos ficheros.
Cuando propongas algún cambio, GitHub creará un pull request. Un pull request es una petición en tu nombre, con las alteraciones propuestas, que permite discutir sobre las mismas. El equipo editorial realizará una revisión de la petición y GitHub te irá notificando en tu correo electrónico conforme se añadan nuevos comentarios.
Atiende los cambios que te hayan pedido y discute cívicamente aquellos en los que no estés de acuerdo, añadiendo tus propios comentarios (podrás utilizar la variante GitHub de Markdown para ello).
Recuerda que puedes editar el fichero directamente desde el navegador, situándote en la página del pull request, pestaña "Files changed", y haciendo click en el botón etiquetado "Change this file using the online editor" y representado con el icono del lápiz.
Solucionar los problemas de un pull request puede no ser el paso final. El proceso de revisión puede repetirse. Atiende las sucesivas revisiones y el equipo editorial aceptará tus cambios cuando todos los problemas se hayan resuelto.
Recuerda que tanto los editores y administradores del repositorio, como tú, somos parte de esta comunidad y estamos sujetos al código de conducta. Informa de los abusos que observes en las pull request (incluso cuando no sean las tuyas) en [email protected]