Helysalgado / github-rs

Repositorio de la materia Python de la LCG

Gestión de Código con Git y GitHub, Python y Buenas Prácticas de Desarrollo de Software

Este repositorio contiene el material de estudio y ejemplos de código utilizados en la materia.

Este repositorio está organizado en carpetas que corresponden a cada ejercicio realizado durante el curso. Todos los ejercicios y ejemplos implementan las buenas prácticas FAIR y buenas prácticas de desarrollo de software siguiendo PEP8.

A. Checklist aplicado a todos los subprojectos de éste repositorio:

1. Prepare prior to the development of the software:
   1.1. Version control system platform : Usaremos Git y GitHub
   1.2. *license: MIT or Apache 2.0 **

2. Follow coding standards and best practices during development
   2.1 code-level documentation: template.py
   2.2 Record dependencies: package.json
   2.3 Language-specific standards and best practices : PEP8
   2.4 Inputs/outputs of the software follow any applicable community standards

3. Document software
   3.1 README

   • Web site using GitHub
   • Documentation for research software: Write the Docs, Doxygen, Sphinx3
     3.2 ChangeLog

4. Include metadata files
   4.1 Codemeta.json metadata
   4.2 CITATION.cff metadata file (tool)

5. Share software on a repository
   5.1 PyPI or Conda for Python packages
   5.2 Zenodo or Figshare repository
   5.3 Archive the software repository on Software Heritage

6. Register software on a registry
   6.1 bio.tools registry or Research Resource Identifiers (RRID) Portal

B. Estructura de la carpeta de cada proyecto. Todo proyecto bajo éste repositorio tiene una organización interna usando una esctructura template basado en la carpeta template-repo que tiene las carpetas recomendadas como bin, lib, docs, results, testysrc` y dentro de ellas existen plantillas para documentar y codificar siguiendo las buenas prácticas.

Cómo utilizar este repositorio

Recomendamos clonar este repositorio en tu computadora local para que puedas experimentar y trabajar con los ejemplos y ejercicios proporcionados. También puedes descargarte el contenido del repositorio como un archivo zip.

Para clonar este repositorio, puedes utilizar el comando git clone seguido de la URL del repositorio. Este comando creará una copia del repositorio en la carpeta en la que te encuentres dentro de tu sistema de archivos local.

Contribuir a este repositorio

Agradecemos y animamos a los estudiantes a contribuir a este repositorio. Si tienes algún ejemplo de código, recurso, lectura o consejo que creas que sería útil para los demás, por favor, no dudes en abrir una Pull Request.

Contáctanos

Si tienes alguna pregunta, sugerencia de mejora o simplemente quieres dejarnos un comentario, no dudes en ponerte en contacto con nosotros a través de la sección de Issues de este repositorio.

Asegúrate de actualizar y adaptar este texto a las necesidades específicas de tu curso.