Cómo contribuir#
¡Gracias por querer aportar! Este proyecto crece con las contribuciones de estudiantes y profesores. Aquí encontrarás todo lo necesario, desde cero.
La idea en una frase#
Cada elemento es una carpeta en
docs/content/<tema>/<id>/. Escribes el códigofull(comentado) en C++ y Python, rellenas unmeta.yaml, y el resto se genera solo: las versionescleanycontest, los tests, la tabla resumen, el grafo de dependencias, el chuletario y la navegación del sitio (no tocasmkdocs.yml).
Ruta recomendada#
- Git y GitHub — si nunca los has usado, empieza aquí.
- Añadir un algoritmo — el paso a paso completo.
- Scripts del proyecto — qué hace cada script y cómo ejecutarlo.
¿Solo quieres proponer una idea o reportar un fallo (sin escribir código)? Ve a Sugerencias e incidencias.
Abrir un Pull Request#
Cuando tengas tus cambios en una rama de tu fork, abre el Pull Request desde aquí. Se rellenará automáticamente con la plantilla de PR (un checklist para que no se te olvide nada):
¿Cómo funciona?
El enlace abre la vista de comparar de GitHub. Elige tu fork y tu rama como origen
y main como destino. Al crear el PR verás el checklist de la plantilla y, cuando la
CI termine, un comentario con el enlace de vista previa de la web.
Requisitos#
- Python 3.11 o superior.
- Un compilador de C++ (
g++) si vas a probar el código C++. - Las dependencias de las herramientas:
Y, si quieres previsualizar la web en local: