From c6dc3bedc3f249b269f0dc8ce30ebd40d926f2ac Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Pablo=20Portas=20L=C3=B3pez?= <81629707+TeenBiscuits@users.noreply.github.com> Date: Tue, 16 Apr 2024 19:36:11 +0200 Subject: [PATCH] =?UTF-8?q?Actualizada=20Gu=C3=ADa=20de=20Contribuci=C3=B3?= =?UTF-8?q?n?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 83 +++++++++++++++++++++++++++++++++---------------- 1 file changed, 56 insertions(+), 27 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index cf80681..164a4e0 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -6,12 +6,25 @@ SPDX-License-Identifier: GPL-3.0-only # Introducción -### Gracias por querer colaborar +> [!IMPORTANT] +> **Gracias por querer colaborar** +> +> Primero de todo gracias por querer colaborar con **Pro2324**, gracias a gente como tú proyectos como este són posibles. -Primero de todo gracias por querer colaborar con **Pro2324**, gracias a gente como tú proyectos como este són posibles. -😄🥰 -### Qué contribuciones se aceptan +- [Introducción](#introducción) + - [Qué contribuciones se aceptan](#qué-contribuciones-se-aceptan) + - [Qué contribuciones no se aceptarán](#qué-contribuciones-no-se-aceptarán) +- [¿Como contribuir?](#como-contribuir) + - [Código](#código) + - [Compilador](#compilador) + - [Documentación](#documentación) + + +## Qué contribuciones se aceptan + +> [!TIP] +> Soluciones a **ejercicios**, **modificaciones**, **ejemplos**, **tutoriales**, **apuntes**... Aceptamos soluciones a **ejercicios** de los boletines, modificaciones de los ya existentes o nuevos ejercicios. También evidentemente **parches a cualquier error** que se escape por el repositorio. @@ -22,9 +35,10 @@ interés, también se añadirán **ejemplos** y/o **extras** que puedan resultar Se aceptan **explicaciones**, **apuntes** y/o **resúmenes** para los apartados de teoría. También **tutoriales** que sean interesantes y estén relacionados con la programación en C y/o similar. -### Qué contribuciones no se aceptarán +## Qué contribuciones no se aceptarán -> **Actualización**: Debido a las normas de Pro II, no se aceptará ningún proyecto, incluso después de la fecha de entrega. +> [!CAUTION] +> Debido a las normas de Pro II, no se aceptará ningún proyecto, incluso después de la fecha de entrega. No se añadirá, ningún **proyecto**. @@ -32,21 +46,30 @@ Tampoco se añadirá código que no sea de creación propia o que fuera consegui Ni se añadirán exámenes, pruebas o demás material **cuyo autor/a no expresase el consentimiento pertinente**. -### ¿Como contribuir? +# ¿Como contribuir? +> [!TIP] > Cita siempre al autor original o a los coautores de todo lo que añadas, **hoy por ti mañana por mi**. -Este Repositorio usa varias funciones de GitHub recientes, entre ellas proyectos. [Enlace al tabloide](https://github.com/users/TeenBiscuits/projects/1) +> [!NOTE] +> Este Repositorio usa varias funciones de GitHub recientes, entre ellas proyectos. [Enlace al tabloide](https://github.com/users/TeenBiscuits/projects/1) -Cuando se añada algo que esté especificado en el tabloide, se añadirá a la **branch** ya abierta para ello. +1. Clonar este repositorio en tu máquina. +```bash +git clone https://github.com/TeenBiscuits/Pro2324.git +``` +O [descargar zip](https://github.com/TeenBiscuits/Pro2324/archive/refs/heads/main.zip) / abrir en GitHub Descktop -En el caso de añadir algo nuevo, pues simplemente haz una pull request. +2. Si vas a contribuir al [código](#código) o la [documentación](#documentación): + 1. [CLion](https://www.jetbrains.com/clion/download) (o cualquier IDE. Ej: [VSCode](https://code.visualstudio.com/)) + 2. [Writerside](https://www.jetbrains.com/writerside/download) -#### Código +## Código -**Todo el código está en la carpeta** ``./src`` **y una copia solo de los archivos** ``*.c`` **en el directorio de la -documentación** ``./docs/code`` Esto es temporal, pero es lo mejor que se puede hacer ahora para que la documentación -funcione. +> [!WARNING] +> **Todo el código está en la carpeta** ``./src`` **y una copia solo de los archivos** ``*.c`` **en el directorio de la documentación** ``./docs/code``. +> +>Esto es temporal, pero es lo mejor que se puede hacer ahora para que la documentación funcione. Para este proyecto se utiliza la revisión de lenguaje C, **C99** (ISO/IEC 9899:1999). El proyecto ha sido estructurado como un proyecto para el IDE **CLion** by JetBrains (R). @@ -55,10 +78,11 @@ Cada boletín de la asignatura se encuentra en una sub carpeta diferente (Boleti parte, son una excepción a esta regla la carpeta *Ejemplos* y *Extras*, donde se añadirá el código hecho en prácticas y el código que se considere de interés respectivamente. -Cada archivo ```*.c``` es un ejecutable diferente declarado en ``./src/*/CMakeLists.txt`` que a su vez es referenciado -en el ``./CMakeLists.txt`` del directorio raíz. (Están todos declarados, los que todavía no fueron añadidos con -un ``#``) Además de añadir sú código también a la carpeta ``./docs/code`` para que pueda ser referenciado más tarde en -la documentación. +> [!NOTE] +> Cada archivo ```*.c``` es un ejecutable diferente declarado en ``./src/*/CMakeLists.txt`` que a su vez es referenciado en el ``./CMakeLists.txt`` del directorio raíz. (Están todos declarados, los que todavía no fueron añadidos con un ``#``) +> +> Además se añadirá su código también a la carpeta ``./docs/code`` para que pueda ser referenciado más tarde en la documentación. + Por norma general en cada boletín **solo se empleará lo aprendido en teoría hasta ese bloque**, así los ejercicios valdrán @@ -83,7 +107,10 @@ Pese a la comodidad de esto, la cabecera que se añadirá será la del **reuse** // SPDX-License-Identifier: GPL-3.0-only ``` -_Si no es añadida por defecto, añádela, así aquellos que ven los archivos en la web sabrán quien creo el archivo._ +> [!NOTE] +> Si no es añadida por defecto, añádela, así aquellos que ven los archivos en la web sabrán quien creo el archivo. + +### Compilador A la hora de compilar los ejecutables puede utilizarse cualquier compilador, pero es recomendable, en Windows, utilizar [Cywing](https://www.cygwin.com) (Para el correcto de display de tíldes y otros caracteres especiales). @@ -91,18 +118,20 @@ utilizar [Cywing](https://www.cygwin.com) (Para el correcto de display de tílde *Tutorial de configuración de Cywing en CLion en Windows 10/11: [Link](https://www.jetbrains.com/help/clion/quick-tutorial-on-configuring-clion-on-windows.html#Cygwin)* -#### Documentación +## Documentación + +> [!NOTE] +> La documentación del proyecto ha sido estructurada como un proyecto para el IDE **Writerside** by JetBrains (R). + +La documentación se separa en dos partes claramente diferenciadas. **Código** y **Teoría**. -La documentación del proyecto ha sido estructurada como un proyecto para el IDE **Writerside** by JetBrains (R). +El código sale de las contribuciones al repositorio principal y se añade a secciones como: Boletines, Exámenes, Tutoriales y Extras. -La documentación se separa en dos partes claramente diferenciadas. Código y Teoría. +La teoría se basa en trabajos previos readaptados a este nuevo formato. Cualquier añadido es bienvenido, siempre que mejore la calidad educativa y la sencillez de las explicaciones. -El código sale de las contribuciones al repositorio principal y se añade a secciones como: Boletines, Exámenes, -Tutoriales y Extras. +_Más no es siempre mejor._ -La teoría se basa en trabajos previos readaptados a este nuevo formato. Cualquier añadido es bienvenido, siempre que -mejore la calidad educativa y la sencillez de las explicaciones. Más no es siempre mejor. La teoría se añade a secciones -como: Apuntes, Ejemplos y Tutoriales. +La teoría se añade a secciones como: Apuntes, Ejemplos y Tutoriales. Las imágenes están en subdirectorios ``./docs/images/*`` para mantener organizado la cantidad inmensa de imágenes.