Skip to content

Contribuir a Paricia¤

¡Gracias por tomarte el tiempo de contribuir a Paricia!

El siguiente es un conjunto de pautas para contribuir a Paricia, un proyecto de sistema de gestión de datos hidroclimáticos basado en Python. El objetivo de estas pautas es hacer que el desarrollo del proyecto sea eficiente y sostenible y garantizar que cada envío lo haga mejor, más legible, más sólido y mejor documentado. No dudes en sugerir cambios y mejoras.

Índice¤

Código de conducta

¿Cómo puedo contribuir?

Guías de estilo

Código de conducta¤

Este proyecto y todos los participantes en él se rigen por el Código de conducta de Paricia. Al participar, se espera que respetes este código. Por favor, informe cualquier comportamiento inaceptable al Administrador del repositorio.

¿Cómo puedo contribuir?¤

Informar errores¤

Esta sección le guía a través del envío de un informe de error para Paricia. Seguir estas pautas ayuda a los encargados del mantenimiento y a la comunidad a:

  • 📝 comprender su informe
  • 💻 reproducir el comportamiento
  • 🔎 encontrar informes relacionados

Antes de crear informes de error, consulte esta lista (incluidos los problemas cerrados) ya que puede descubrir que no necesita crear uno. Cuando esté creando un informe de error, incluya tantos detalles como sea posible.

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 del nuevo.

¿Cómo envío un (buen) informe de error?¤

Los errores se registran como problemas de GitHub. Explique el problema e incluya detalles adicionales para ayudar a los encargados de mantenimiento a reproducirlo:

  • Use un título claro y descriptivo para el problema para identificarlo.
  • Describe los pasos exactos que reproducen el problema con tantos detalles como sea posible. Por ejemplo, comience explicando cómo instaló Paricia y qué estaba tratando de hacer.
  • Proporcione ejemplos específicos para demostrar los pasos. Incluya enlaces a archivos o proyectos de GitHub, o fragmentos que se puedan copiar y pegar, que use en esos ejemplos. Si proporciona fragmentos en el problema, utilice bloques de código Markdown.
  • Describe el comportamiento que observaste después de seguir los pasos y señala cuál es exactamente el problema con ese comportamiento.
  • Explica qué comportamiento esperabas ver en su lugar y por qué.
  • Si hay algún resultado de error en la terminal, incluye ese resultado en tu informe.

Proporciona más contexto respondiendo estas preguntas:

  • ¿El problema comenzó a ocurrir recientemente (por ejemplo, después de actualizar a una nueva versión de Paricia) o siempre fue un problema?
  • Si el problema comenzó a ocurrir recientemente, ¿puedes reproducir el problema en una versión anterior de Paricia? ¿Cuál es la versión más reciente en la que no ocurre el problema? Puedes descargar versiones anteriores de Paricia desde la página de versiones.
  • ¿Puedes reproducir el problema de manera confiable? Si no, proporciona detalles sobre la frecuencia con la que ocurre el problema y bajo qué condiciones ocurre normalmente.

Incluye detalles sobre tu configuración y entorno:

  • ¿Qué versión de Paricia estás usando?
  • ¿Cuál es el nombre y la versión del sistema operativo que estás usando?
  • ¿Estás ejecutando Paricia en una máquina virtual? Si es así, ¿qué software de VM estás usando y qué sistemas operativos y versiones se usan para el host y el invitado?

Sugerencias de mejoras¤

Esta sección te guía a través del envío de una sugerencia de mejora para Paricia, incluidas características completamente nuevas y mejoras menores a la funcionalidad existente. Seguir estas pautas ayuda a los encargados del mantenimiento y a la comunidad a comprender tu sugerencia y encontrar otras relacionadas.

Antes de crear sugerencias de mejora, consulta esta lista (incluidos los problemas cerrados), ya que es posible que descubras que no necesitas crear una. Cuando cree una sugerencia de mejora, incluya tantos detalles como sea posible (#¿Cómo envío una buena sugerencia de mejora?).

¿Cómo envío una buena sugerencia de mejora?¤

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

Tu primera contribución de código¤

¿No estás seguro de por dónde empezar a contribuir con Paricia? Puedes empezar por revisar estos problemas para principiantes y para quienes necesitan ayuda:

Pull Requests¤

El proceso que se describe aquí tiene varios objetivos:

  • Mantener la calidad de Paricia
  • Solucionar problemas que son importantes para los usuarios
  • Involucrar a la comunidad en el trabajo para lograr la mejor Paricia posible
  • Permitir un sistema sostenible para que los encargados de mantenimiento de Paricia revisen las contribuciones

Siga estos pasos para que los encargados de mantenimiento consideren su contribución:

  1. Describa claramente cuál es el propósito de la pull request. Consulte los problemas relevantes en Errores o Mejoras. En general, un problema siempre debe abrirse antes de una pull request, para discutir su contenido con un encargado de mantenimiento y asegurarse de que tenga sentido para Paricia. Si la pull request es un trabajo en progreso que llevará algún tiempo para estar listo pero aún así desea discutirlo con la comunidad, abra un borrador de pull request.
  2. Incluya pruebas unitarias y pruebas de integración relevantes, cuando sea necesario. El conjunto de pruebas de Paricia es bastante limitado en este momento. Estamos trabajando para mejorar esto y probar tantas características como sea posible, por lo que cualquier nueva incorporación al código debe venir con su propio conjunto de pruebas para evitar retroceder en este asunto.
  3. Para nuevas características y mejoras, incluya documentación y ejemplos. Tanto en el código, como cadenas de documentación en clases, funciones y módulos, y como documentación adecuada que describa cómo usar la nueva característica.
  4. Siga las guías de estilo
  5. Después de enviar su solicitud de extracción, verifique que todas las verificaciones de estado estén pasando
    ¿Qué pasa si las verificaciones de estado fallan?Si una verificación de estado falla y cree que el error no está relacionado con su cambio, deje un comentario en la solicitud de extracción explicando por qué cree que el error no está relacionado. Un encargado de mantenimiento volverá a ejecutar la verificación de estado por usted. Si concluimos 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 anteriores deben cumplirse antes de que se revise su solicitud de incorporación de cambios, el revisor o los revisores pueden solicitarle que complete trabajo de diseño adicional, pruebas u otros cambios antes de que su solicitud de incorporación de cambios pueda ser finalmente aceptada.

Guías de estilo¤

Mensajes de confirmación de Git¤

  • Use el tiempo presente ("Agregar característica" no "Característica agregada")
  • Use el modo imperativo ("Mover el cursor a..." no "Mueve el cursor a...")
  • Limite la primera línea a 72 caracteres o menos
  • Haga referencia a problemas y solicitudes de incorporación de cambios generosamente después de la primera línea
  • Cuando solo cambie la documentación, incluya [ci skip] en el título de la confirmación
  • Considere comenzar el mensaje de confirmación con un emoji aplicable:
  • 🎨 :art: cuando mejore el formato/estructura del código
  • 🐎 :racehorse: cuando mejore el rendimiento
  • 🚱 :non-potable_water: cuando solucione fugas de memoria
  • 📝 :memo: cuando escriba documentación
  • 🐧 :penguin: cuando arregle algo en Linux
  • 🍎 :apple: cuando arregle algo en macOS
  • 🏁 :checkered_flag: al reparar algo en Windows
  • 🐛 :bug: al reparar un error
  • 🔥 :fire: al eliminar código o archivos
  • 💚 :green_heart: al reparar la compilación de CI
  • ✅ :white_check_mark: al agregar pruebas
  • 🔒 :lock: al lidiar con la seguridad
  • ⬆ :arrow_up: al actualizar dependencias
  • ⬇ :arrow_down: al degradar dependencias
  • 👕 :shirt: al eliminar advertencias de linter

Guía de estilo de la documentación¤

  • Use Markdown.
  • Métodos y clases de referencia en Markdown con la notación personalizada {}:
  • Clases de referencia con {ClassName}
  • Métodos de instancia de referencia con {ClassName::methodName}
  • Métodos de clase de referencia con {ClassName.methodName}