Skip to content

Latest commit

 

History

History
39 lines (29 loc) · 18.6 KB

BestPractice.md

File metadata and controls

39 lines (29 loc) · 18.6 KB

Consejos y buenas prácticas de desarrollo colaborativo:blue_heart:

Algunos consejos que tal vez te sean de utilidad a la hora de crear y mantener tus repositorios.

El concepto de buenas prácticas (BBPP) ha permeado indiscriminadamente en la educación dando pie a la existencia de distintas acepciones e interpretaciones sobre su deber ser, así como de las estrategias para su detección. Las buenas prácticas educativas (BBPPEE) son promovidas para referir un conjunto de acciones o principios que gozan de reconocimiento por los resultados positivos que se pueden obtener de su replicación. En el nivel superior se presentan con frecuencia asociadas a la integración de tecnologías digitales, resaltando el valor de estas para lograr tal reconocimiento.1

Consejo o buena práctica Alcance Autor
Descarga periódicamente copias individuales comprimidas de tus repositorios En caso de que tu cuenta de usuario sea hackeada o accidentalmente eliminada, mantener copias comprimidas actualizadas de las versiones oficiales que vas liberando, te permitirá no perder todo el esfuerzo que has dedicado en la creación de tus contenidos. Si bien otros usuarios o las organizaciones a las cuales perteneces pueden haber clonado tus repositorios, estos pueden estar desactualizados. rcfdtools
Actualizar clonaciones Cuando clones y utilices con frecuencia repositorios de otros creadores de contenido, revisa la versión oficial y en caso de que encuentres nuevas y mejores versiones, actualiza los datos clonados. rcfdtools
Referenciar y citar otros repositorios Siempre que utilices el contenido de otro autor, asegúrate de citar el repositorio o el autor, esto fortalece las redes colaborativas, incentiva a los creadores de contenido a mantener actualizados los repositorios y es un acto de cortesía. rcfdtools
Anexos técnicos y científicos Cuando crees contenidos orientados a toma de decisiones, asegúrate de incluir en el repositorio, anexos o referencias técnicas y científicas verificables. rcfdtools
Crea y documenta investigaciones y artículos directamente en GitHub Esta práctica te permitirá para mantener el historial detallado de cambios y la línea de tiempo de las incorporaciones, revisiones e integraciones de otros investigadores o autores. Cargar versiones finales de documentos en el repositorio no permite evaluar la trazabilidad de los contenidos publicados. rcfdtools
Colabora, participa y construye Mantén una actitud proactiva y propositiva frente a los contenidos publicados por otros autores. Si detectas un error, un concepto equivocado, información o procedimientos desactualizados o un fallo, escríbele al autor a través de las discusiones o a través de las opciones integradas de Issues o mediante clonaciones y solicitudes de integración, planteando en detalle las correcciones o los ajustes requeridos. rcfdtools
Readme.md Incluye siempre un archivo de documentación Readme.md dentro de cada carpeta o subcarpeta e incluye una descripción de su propósito y contenido. rcfdtools
Licencia de uso Selecciona una de las licencias disponibles en GitHub o incluye una licencia derivada en la raíz del repositorio con el nombre LICENSE.md. Se recomienda asesoría profesional. rcfdtools
Archivos grandes Cuando tu proyecto a través de una cuenta de no pago requiera de la publicación de archivos de más de 100 MB, crea comprimidos en partes de 95 MB para que estos puedan ser cargados. Aplica este mismo recurso para paquetes que ocupen más de 500 MB. - rcfdtools
Investiga - Desarrolla - Comparte Cada vez dediques tiempo a investigar, aprender y crear algo nuevo (una App, una herramienta computacional, un procedimiento...), compártelo e integralo en uno e tus repositorios. Seguramente, alguien más necesitará de este conocimiento y podrá utilizar tus creaciones. rcfdtools
Rutas relativas Enlaza los vínculos de los contenidos propios de tu repositorio a través de rutas relativas y evita el uso de rutas absolutas. P. ej., en vez de llamar desde una subcarpeta un ícono global a través de su enlace completo en GitHub https://github.com/rcfdtools/R.TeachingResearchGuide /blob/main/.icons/R.TeachingResearchGuide.svg, utiliza la referencia relativa .icons/R.TeachingResearchGuide.svg. Si estás dentro de una subcarpeta, con ../ podrá regresar al nivel anterior y realizar la referencia como ../.icons/R.TeachingResearchGuide.svg. Cuando estés usando herramientas Desktop para gestionar los archivos y documentos del proyecto, la previsualización mostrará los elementos vinculados (p. ej. las imágenes) debido a que las rutas de los archivos serán resueltas localmente. rcfdtools
Código de conducta Desde las opciones de Insights localizada en la parte superior de tu repositorio, selecciona en el panel lateral Community Standards y selecciona o crea un código de conducta. Una vez creado, los usuarios podrán acceder a él desde panel lateral derecho de la raíz del repositorio. rcfdtools
Dedicación Proponte trabajar en tus repositorios un tiempo mínimo por semana, así mantendrás actualizados los contenidos y aumentará la posibilidad de uso y colaboración por parte de otros. juanrodace
Discusiones Habilita el espacio de discusiones en tus repositorios para mejorar la participación y colaboración de tus repositorios. juanrodace
Motivación Planea desarrollar algún proyecto colaborativo y mantén contacto permanente con al menos un miembro del equipo para que conserven la motivación mutua y así participen activamente. juanrodace
Toma nota Cuando se te ocurra una idea, una mejora o complementar una actividad, toma notas electrónicas (p. ej., en Google Keep crea notas separadas para cada proyecto o repositorio usando casillas de verificación) y agregala a la lista de pendientes. Al terminar de implementar uno o varios elementos de tu lista, marcalas como completadas. rcfdtools
Descripción / About & Topics Todo repositorio en GitHub requiere de una descripción y palabras clave, asegúrate que la descripción represente el contenido o el propósito del repositorio e incluye palabras clave acorde con los temas principales contenidos en el repositorio. EL meta-buscador de GitHub utiliza estos dos elementos para mostrar los repositorios que contienen elementos relacionados al criterio de búsqueda ingresado. rcfdtools

Comparte consejos y buenas prácticas desde Ayuda / Colabora.

R.TeachingResearchGuide es de uso libre para fines académicos, conoce nuestra licencia, cláusulas, condiciones de uso y como referenciar los contenidos publicados en este repositorio, dando clic aquí.

¡Encontraste útil este repositorio!, apoya su difusión marcando este repositorio con una ⭐ o síguenos dando clic en el botón Follow de rcfdtools en GitHub.

🏠 Inicio 🔰 Ayuda / Colabora

Footnotes

  1. Tomado de https://www.redalyc.org/journal/5216/521662150036/