Skip to content

Latest commit

 

History

History
120 lines (92 loc) · 6.91 KB

CONTRIBUTING.md

File metadata and controls

120 lines (92 loc) · 6.91 KB
Raw

Contribuyendo

Software Carpentry y Data Carpentry son ​ proyectos de código abierto, y damos la bienvenida a contribuciones de todo tipo: nuevas lecciones, correcciones al material existente, informes de errores, y revisiones de los cambios propuestos son todas bienvenidas.

Acuerdo de Colaborador

Al contribuir, tú aceptas que podemos redistribuir su trabajo bajo nuestra licencia. A cambio, abordaremos tus problemas y/o evaluaremos tu propuesta de cambio tan pronto como podamos, y te ayudaremos a convertirte en miembro de nuestra comunidad. Todos los involucrados en Software Carpentry y Data Carpentry aceptan cumplir con nuestro código de conducta.

Cómo contribuir

La forma más fácil de comenzar es presentar un problema para poder corregirlo, como un error ortográfico, algunas palabras no claras, o un error fáctico. Contribuir es una buena forma de presentarte y conocer a algunos de los miembros de nuestra comunidad.

  1. Si no tienes una cuenta de GitHub, puedes enviarnos comentarios por correo electrónico. Sin embargo, podremos responder más rápidamente si usa uno de los otros métodos que se describen a continuación.

  2. Si tiene una cuenta de GitHub, o están dispuestos a crear una, pero no sabes cómo usar git, puedes informar problemas o sugerir mejoras al crear un problema o issue. Esto nos permite asignar el elemento a alguien y responder en una conversación abierta.

  3. Si te sientes cómodo con Git, y te gustaría agregar o cambiar material, puede enviar una solicitud de extracción o pull request(PR). Las instrucciones para hacer esto se incluyen a continuación.

Donde Contribuir

  1. Si deseas cambiar esta lección, por favor trabaja en https://github.com/swcarpentry/shell-novice-es, que se puede ver en https://swcarpentry.github.io/shell-novice-es.

  2. Si deseas cambiar la lección de ejemplo, por favor trabaja en https://github.com/carpentries/lesson-example, que documenta el formato de nuestras lecciones y se puede ver en https://carpentries.github.io/lesson-example.

  3. Si deseas cambiar la plantilla utilizada para los sitios web del taller, por favor trabaja en https://github.com/carpentries/workshop-template. La página de inicio de ese repositorio explica cómo configurar sitios web de talleres, mientras que las páginas adicionales en https://carpentries.github.io/workshop-template proporcionan más antecedentes sobre nuestras elecciones de diseño.

  4. Si deseas cambiar los archivos de estilo CSS, herramientas, o texto estándar HTML para lecciones o talleres almacenados en _includes o _layouts, por favor trabaja en https://github.com/carpentries/styles-es.

Qué aportar

Hay muchas maneras de contribuir, de escribir nuevos ejercicios y mejorar los existentes para actualizar o completar la documentación y enviando informes de error o issues sobre cosas que no funcionan, no son claras o faltan. Si estás buscando ideas, por favor ve la lista de problemas para este repositorio, o los problemas o issues para los proyectos de Data Carpentry y Software Carpentry.

Los comentarios sobre problemas y revisiones de solicitudes de extracción son igualmente bienvenidos: somos más fuertes juntos que solos, por eso trabajamos en equipo. Los comentarios de principiantes y recién llegados son particularmente valiosos: es fácil para las personas que han estado usando estas lecciones por un tiempo, olvidar lo impenetrable que puede ser parte de este material, por lo que los ojos frescos son siempre bienvenidos.

Qué No contribuir

Nuestras lecciones ya contienen más material de lo que podemos cubrir en un taller típico, por lo que usualmente no buscamos más conceptos o herramientas para agregar. Como una regla, si quieres presentar una nueva idea, debes (a) estimar cuánto tiempo llevará enseñar y (b) explicar lo que sacaría para darle espacio al nuevo concepto. El primero alienta a los contribuyentes a ser honestos acerca de los requisitos; el segundo, pensar mucho sobre las prioridades.

Tampoco buscamos ejercicios u otro material que sólo se ejecute en una plataforma. Nuestros talleres suelen contener una mezcla de usuarios de Windows, Mac OS X y Linux; para ser utilizable, nuestras lecciones deben correr igualmente bien en las tres plataformas.

Usando GitHub

Si eliges contribuir a través de GitHub, es posible que desees mirar Cómo contribuir a un proyecto de código abierto en GitHub.

En breve:

  1. La copia publicada de la lección está en la rama gh-pages del repositorio (para que GitHub lo regenere automáticamente). Por favor crea todas las ramas de eso, y fusiona la rama gh-pages de repositorio maestro en la rama gh-pages antes de comenzar a trabajar. Por favor, no trabajes directamente en tu rama gh-pages, ya que esto te dificultará trabajar en otras contribuciones.

  2. Usamos GitHub flow para gestionar los cambios:     1. Crea una nueva rama en su copia de escritorio de este repositorio para cada cambio significativo.     2. Commit el cambio en esa rama.     3. Push esa rama a su fork de este repositorio en GitHub.     4. Envía una solicitud de extracción Pull request desde esa rama al repositorio principal.     5. Si recibes comentarios,         hacer cambios en tu escritorio y enviar a GitHub:         la solicitud de extracción se actualizará automáticamente.

Cada lección tiene dos mantenedores que revisan problemas y solicitan extracción o alentan a otros a hacerlo. Los mantenedores son voluntarios de la comunidad, y tienen una opinión final sobre lo que se fusiona en la lección.

Otros recursos

Discusión general de Software Carpentry y Data Carpentry sucede en la lista de distribución de discusiones, a la cual todos son bienvenidos. También puedes contactarnos por correo electrónico.