CONTRIBUTING.md

Contribuyendo

👍🎉 Antes que nada, gracias por tomarse el tiempo para contribuir! 🎉👍

El siguiente es un conjunto de pautas para contribuir a Real-Analysis-Project. Estas son en su mayoría directrices, no reglas. Use su mejor criterio y siéntase libre de proponer cambios a este documento en una solicitud de extracción.

Tabla de contenidos

Código de conducta

¿Cómo puedo contribuir?

• Reportando errores
• Antes de enviar un informe de error
• ¿Cómo presento un buen informe de error?
• Sugiriendo mejoras
• ¿Cómo presento una (buena) sugerencia de mejora?
• Solicitud de extracción

Guía de estilos

• Git commit mensajes
• Guía de estilo LaTeX

Código de conducta

Este proyecto y todos los que participan en él se rigen por el código de conducta. Al participar, se espera que respete este código. Por favor reporte un comportamiento inaceptable a caznaranl@uni.pe.

Si para ti el chat es más rápido, puedes unirte al equipo en:

• Únete al equipo

¿Cómo puedo contribuir?

• Acepte la invitación para colaborar en el repositorio de trabajo, el cual se encontrará en la bandeja de entrada del correo electrónico.
• Dirígase al tablero en su cuenta de GitHub y busque el nombre del repositorio.

• Ahora clone el repositorio de la siguiente manera. Ejecute en la terminal las siguientes instrucciones:

me@linux:~$ git clone https://github.com/carlosal1015/Real-Analysis-Project.git # Clonar el repositorio.
me@linux:~$ git submodule update --init --recursive # Clonar los submódulos

Opcional: Configuración de git

Asegúrese de haber vinculado sus credenciales Git en la terminal. En caso negativo, escriba las siguientes instrucciones para configurarlo. Se recomienda que reemplace la cadena de texto entre comillas por su e-mail y usuario que está registrado en GitHub.

me@linux:~$ git config --global user.email "example@example.com" # Configurar email
me@linux:~$ git config --global user.name "John Doe" # Configurar usuario

Luego de haber clonado satisfactoriamente el repositorio, será momento de contribuir con el proyecto. En esta ocasión se utilizarán las ramas.

me@linux:~$ cd Real-Analysis-Project # Ir al directorio.
me@linux:~$ git pull origin master   # Descargar los cambios.
me@linux:~$ git checkout -b myFeature # Nombre de la rama
me@linux:~$ git push origin myFeature # Suba su rama a GitHub.

Ahora, puede empezar a agregar ficheros y cuando acabe realice las siguientes instrucciones:

me@linux:~$ git commit -am "Your message"
me@linux:~$ git push -u origin myFeature

Muy bien, ahora debes crear un pull request. Dirígite a la página del repositorio

Ya casi, finalmente en el recuadro derecho seleccionas en el lado izquierdo el nombre de la rama que has creado, es decir, myFeature, en la imagen está la rama introduction. Para finalizar, agrega un título y describe los cambios añadidos. Para finalizar, clic en el botón verde submmit.

Actualizando rama de trabajo

Luego de haber realizado con éxito el pull request, es momento de regresar a nuestra rama principal y sincronizar

me@linux:~$ git checkout myFeature
me@linux:~$ git pull origin master
me@linux:~$ git commit -am "Your new message"
me@linux:~$ git push -u origin myFeature

Y así sucesivamente. ¡Lo lograste!

Reportando errores

Esta sección lo guía a través de la presentación de un informe de error. Seguir estas pautas ayuda a los mantenedores y a la comunidad a entender su informe 📝, reproducir el comportamiento 💻 💻 y encontrar informes relacionados 🔎.

Antes de crear informes de errores, por favor, compruebe esta lista como podría descubrir que no necesita crear uno. Cuando está creando un informe de error, por favor incluya tantos detalles como sea posible. Llene la plantilla requerida, la información que solicita nos ayuda a resolver problemas más rápido.

Nota: Si encuentra un problema cerrado que parece ser lo mismo que está experimentando, abra un nuevo problema e incluya un enlace al problema original en el cuerpo de su nuevo problema.

Antes de enviar un informe de error

• Compruebe que su código compila, caso contrario comente las líneas que producen errores.
• Busque la solución en algún foro como TXS para una lista de preguntas y problemas comunes.

¿Cómo presento un buen informe de error?

Cree un problema en ese repositorio y proporcione la siguiente información al completar la plantilla.

Explique el problema e incluya detalles adicionales para ayudar a los mantenedores a reproducir el problema.

Sugiriendo mejoras

Esta sección lo guía a través del envío de una sugerencia de mejora para Atom, que incluye funciones completamente nuevas y mejoras menores en la funcionalidad existente. Seguir estas pautas ayuda a los mantenedores y a la comunidad a entender su sugerencia 📝 y encuentra sugerencias relacionadas 🔎.

Cuando esté creando una sugerencia de mejora, por favor incluir tantos detalles como sea posible. Rellene en la plantilla, incluyendo los pasos que imagina que tomaría si existiera la función que está solicitando.

¿Cómo presento una (buena) sugerencia de mejora?

Las sugerencias de mejora se rastrean como problemas de GitHub. Cree un problema en ese repositorio y proporcione la siguiente información:

• Usa un título claro y descriptivo para el tema e identificar la sugerencia.
• Proporcione una descripción paso a paso de la mejora sugerida en tantos detalles como sea posible.
• Proporcionar ejemplos específicos para demostrar los pasos. Incluya fragmentos de copia que use en esos ejemplos, como Bloques de código de Markdown.
• Describe el comportamiento actual y explique qué comportamiento esperaba ver en su lugar y el porqué.
• Incluye capturas de pantalla y GIF animados que le ayudan a demostrar los pasos o señalar la parte a la que se relaciona la sugerencia. Puede utilizar esta herramienta para grabar GIFs en macOS y Windows, y esta herramienta o this tool en GNU/Linux.
• Explica por qué esta mejora sería útil para la mayoría de los usuarios.
• Enumere algunos otros editores de texto o aplicaciones donde exista esta mejora.
• Especifique qué versión de TeX Live está utilizando. Puede obtener la versión exacta ejecutando tex --version en su terminal.
• Especifique el nombre y la versión del sistema operativo que está utilizando.

Solicitud de extracción

El proceso descrito aquí tiene varios objetivos:

• Mantener la calidad del trabajo
• Solucionar los problemas que son importantes para los usuarios
• Haga que la comunidad trabaje para lograr el mejor trabajo
• Habilitar un sistema sostenible para que los mantenedores revisen las contribuciones

Por favor, siga estos pasos para que su contribución sea considerada por los mantenedores:

1. Siga todas las instrucciones en la plantilla
2. Siga la guía de estilos
3. Después de enviar su solicitud de extracción, verifique que todos controles de estado están pasando
   ¿Qué pasa si las comprobaciones de estado fallan?

   Si la verificación de estado falla y cree que la falla no está relacionada con su cambio, deje un comentario en la solicitud de extracción que explique por qué cree que la falla no está relacionada. Un mantenedor volverá a ejecutar la verificación de estado por usted. Si llegamos a la conclusión de que el error fue un falso positivo, abriremos un problema para rastrear ese problema con nuestro conjunto de verificación de estado.

Si bien los requisitos previos mencionados anteriormente deben cumplirse antes de que se revise su solicitud de extracción, los revisores pueden pedirle que complete trabajos de diseño, pruebas u otros cambios adicionales antes de que su solicitud de extracción sea finalmente aceptada.

Guías de estilos

Git commit mensajes

• Usa el tiempo presente ("Añadir característica" not "Característica agregada")
• Usa el modo imperativo ("Mover el cursor a..." not "Mueve el cursor a...")
• Limite la primera línea a 72 caracteres o menos
• Referencia de problemas y solicitudes de extracción liberalmente después de la primera línea
• Considere comenzar el mensaje de confirmación con un emoji aplicable:
  • 🎨 :art: al mejorar el formato/estructura del código
  • 🐎 :racehorse: cuando se mejora el rendimiento
  • 🚱 :non-potable_water: al conectar las fugas de memoria
  • 📝 :memo: al escribir documentos
  • 🐧 :penguin: al arreglar algo en Linux
  • 🍎 :apple: al arreglar algo en macOS
  • 🏁 :checkered_flag: al arreglar algo en Windows
  • 🐛 :bug: cuando arreglamos un error
  • 🔥 :fire: al eliminar código o archivos
  • ✅ :white_check_mark: al agregar pruebas
  • 🔒 :lock: cuando se trata de seguridad
  • ⬆️ :arrow_up: al actualizar paquetes
  • ⬇️ :arrow_down: al degradar paquetes
  • 👕 :shirt: al eliminar las advertencias

Guía de estilo LaTeX

Todo código LaTeX debe cumplir con estilo estándar de LaTeX y el código legible estándar, además de unas convenciones seguidas por @Oromion.

• Prefiere el operador de propagación de objetos (\[ \]) a $$ $$
• Inline exports with expressions whenever possible

  % Use esto:
    \begin{enumerate}
      \item
      \item
      \item
        \begin{enumerate}
          \item
          \item
        \end{enumerate}
    \end{enumerate}
  % En vez de:
    \begin{enumerate}
    \item
    \item
    \item
    \begin{enumerate}
    \item
    \item
    \end{enumerate}
    \end{enumerate}

Ejemplo

\begin{proof}
  \begin{enumerate}
     \item Esto sigue inmediatamente por el ``Principio de Superposición''.
     \item Para todo $i\in\left\{0,\ldots,r-1 \right\}$ sea $\left(u^{i}_{n}\right)_{n}$ la solución de \eqref{4} con $r$--sucesión de datos iniciales iguales a $0$ para lugares $j\neq i$, iguales a $1$ en lugares $i$, es decir: \[ u^{i}_{j}=0\text{ si }j\neq i,\quad u^{i}_{i}=1\quad j\in\left\{0,\ldots,r-1 \right\}. \]
  \end{enumerate}
\end{proof}