Como publicar scripts y repositorios en GitHub
¿Que es GitHub?
GitHub es una plataforma que permite el desarrollo colaborativo de proyectos relacionados con la programación y que utiliza el sistema de control de versiones Git. Aunque el objetivo principal de la plataforma es el desarrollo de proyectos, también es utilizado como repositorio de almacenamiento de códigos relacionados a la investigación, permitiendo compartir scripts y datos utilizados necesarios para reproducir los resultados de dicha investigación, en ese contexto, también se pueden asociar los repositorios en GitHub con la publicación de recursos en la plataforma Zenodo
¿Que puedo publicar en GitHub?
En la plataforma se pueden publicar todo tipo de archivos, sin embargo los archivos principales a publicar son:
- Scripts utilizados para realizar el análisis de datos
- Conjuntos de datos necesarios para poder utilizar los scripts publicados
En el caso de necesitar publicar el set completo de datos, se recomienda realizar un recurso diferente en Zenodo e indicar el DOI asociado a dicha publicación en los comentarios del código y descripción de la publicación en GitHub
¿Qué información se necesita para publicar en GitHub?
Junto con los scripts y/o datos que se desean publicar, es necesario entregar la siguiente información de manera obligatoria para poder completar la publicación:
- Nombre del repositorio: debe ser corto y evitar tener caracteres especiales. Este nombre es el que se verá visible en el URL definitivo del repositorio
- Descripción corta: entrega información simple sobre que se encuentra en el repositorio
- Visibilidad: Existen dos opciones de visibilidad en los repositorios en GitHub
- Publica: cualquiera puede encontrar, visualizar y descargar los archivos que se encuentran en el repositorio
- Privada: sólo puede accederse a aquellos usuarios a que se les de acceso.
Otra información que es requerida para asegurar la calidad y el cumplimiento con los principios FAIR adoptados por el Instituto Milenio BASE en caso de que el repositorio tenga visibilidad Pública es la siguiente:
- Breve descripción de cada uno de los archivos (lenguaje de programación, análisis contenidos, relación con otros archivos si lo hubiese, versión de software utilizados)
- Autores de los scripts y/o datos
- Licencia: se puede escoger una de las siguientes
- Apache License 2.0
- GNU General Public License v3.0
- MIT License
- BSD 2-Clause “Simplified” License
- BSD 3-Clause “New” or “Revised” License
- Boost Software License 1.0
- Creative Commons Zero v1.0 Universal
- Eclipse Public License 2.0
- GNU Affero General Public License v3.0
- GNU General Public v2.0
- GNU Lesser General Public License v2.1
- Mozilla Publix License 2.0
- The Unlicense
- None
Catalina Marín Cruz
cmarin@institutobase.cl
Asunto: Publicación de repositorio en GitHub