Guía · Categoría 6
Depositar el código
El software sigue este camino: repositorio público → Software Heritage → ZIP adjunto en el depósito único de BURJC, más un capítulo que lo describe en el libro. Tiene que ser código de verdad.
- Un PDF o una guía (por ejemplo, de Git) con enlaces a repositorios, pero sin el código dentro del depósito.
- Documentos que en realidad son apuntes o enunciados. Esos van en las categorías 1 o 3.
Requisitos
- Está en un repositorio público (GitHub, GitLab…) y archivado en Software Heritage.
- Se usa en la asignatura este curso y al menos un docente de la asignatura es autor.
- Incluye instrucciones de uso (README) y todo el código fuente.
- Tiene una licencia aprobada por la OSI (GPL-3.0, MIT, Apache-2.0…) en un fichero
LICENSE. - Rúbrica: para 8 puntos, útil de forma fundamental en al menos el 90 % del temario y con una cantidad notable de código.
Paso a paso
Prepara el repositorio
Añade un
README.mdque explique para qué sirve en la asignatura y cómo usarlo, y unLICENSE. Recomendado: una cabecera con copyright e identificador SPDX en cada fichero fuente, y el contenido ordenado por temas o prácticas.Publícalo
Súbelo a GitHub o GitLab como repositorio público. Truco: si lo marcas como Template en GitHub, cualquier docente o estudiante puede crear su copia con un clic.
Archívalo en Software Heritage
Primero actualiza el repositorio con la versión que vas a presentar. Después, en Save code now, pega la URL y pide el archivado. La extensión del navegador lo hace más cómodo.
Obtén el SWHID y el tar.gz
Busca el repositorio en el archivo, abre History, elige la versión y pulsa Download. El nombre del fichero descargado es el SWHID: quita
.tar.gzy cambia_por:, por ejemploswh:1:dir:46dfa1d1….Si tienes varios repositorios, agrúpalos
Mete todos los tar.gz en un único
codigo-fuente.zipjunto con un README general que tenga una tabla con el repositorio, su SWHID y su tema. Ejemplo abajo.Escribe el capítulo del libro
Explica qué programas hay, en qué temas se usan, la URL del repositorio y el SWHID. Puedes incluir el README en PDF:
pandoc README.md -o README.pdf. La plantilla traecapitulos/6-software.tex.Adjúntalo en el depósito único de BURJC
Sube el ZIP como adjunto en el mismo depósito que el libro, no en uno aparte. En la descripción del depósito indica:
codigo-fuente.zip: programas de ordenador utilizados en la asignatura <nombre temático>. Archivo con código fuente, depositado en Software Heritage con el SWHID swh:1:dir:<id>. Incluye <plantillas y soluciones de las prácticas de laboratorio / programas de ejemplo…>. Repositorio público: <url>.
Ejemplo de README general
Es el formato que usamos en Estructuras de Datos: una fila por práctica, con su repositorio plantilla y su SWHID.
# Programas de la asignatura <Nombre> **Licencia** ©2026 Nombre Apellido y Nombre Apellido. Algunos derechos reservados. Código bajo licencia GPL-3.0-or-later (ver LICENSE en cada repositorio). Documentación bajo licencia CC BY-SA 4.0. Material docente en abierto de la Universidad Rey Juan Carlos. ## Repositorios | Tema | Repositorio | Software Heritage | | :--- | :--- | :--- | | 1. Punteros | [Lab01-Punteros](https://github.com/org/Lab01-Punteros) | `swh:1:dir:90acac61…` | | 2. TADs | [Lab02-TAD](https://github.com/org/Lab02-TAD) | `swh:1:dir:9f396aeb…` | ## Cómo usarlos 1. Pulsa «Use this template» en GitHub (o descarga el ZIP). 2. …
Checklist rápido
- ☐ README con el propósito docente y las instrucciones
- ☐ LICENSE aprobada por la OSI
- ☐ Versión archivada en Software Heritage y SWHID apuntado
- ☐ ZIP con el código fuente, y el código objeto si es relevante
- ☐ Capítulo en el libro con los programas, sus temas y los SWHID
- ☐ ZIP adjunto al mismo depósito, con la descripción que menciona el SWHID