Skip to content

Latest commit

 

History

History
52 lines (34 loc) · 3.97 KB

CONTRIBUTING.md

File metadata and controls

52 lines (34 loc) · 3.97 KB
Raw

1. Contribuyendo a nuestro proyecto

¡Saludos y bienvenidos a nuestro proyecto! Estamos encantados con su interés en contribuir. Este documento sirve como una guía completa, brindándole información sobre cómo configurar su entorno de desarrollo y describiendo las pautas a seguir al modificar archivos o realizar contribuciones.

1.1. Estándares de codificación

Para el desarrollo de este proyecto, utilizamos la biblioteca black para formatear el código de acuerdo con PEP8 un estándar de estilo de código para Python. Además, utilizamos pre-commit para administrar hooks de Git personalizados. Estas herramientas nos ayudan a mantener un estilo de código coherente en todos los archivos Python del proyecto y a mantener el historial de commits en línea con el estándar ConventionalCommits. Estas bibliotecas ya están configuradas en el proyecto, sin embargo, para que funcionen correctamente se deben realizar los siguientes pasos:

  • Paso 1 (Instalación de los hooks): Un hook de Git es un script que Git ejecuta antes o después de eventos como commit, push o merge. Estos enlaces se utilizan para automatizar tareas en el flujo de trabajo de desarrollo, como aplicar un formato de mensaje de confirmación, ejecutar pruebas antes de realizar una confirmación o incluso verificar el estilo del código. Este proyecto incluye dos hooks personalizados que garantizan que el código tenga el formato correcto y que el mensaje de confirmación cumpla con el estándar ConventionalCommits, para inicializar estas validaciones dedbes ejecutar los siguientes comandos.

    pre-commit install
pre-commit install --hook-type commit-msg

1.2. Directrices para los commits

Usamos la biblioteca commitizen para gestionar mensajes de confirmación, esta biblioteca simplifica el proceso de realizar un commit a través de una interfaz de terminal donde mediante pasos se irá construyendo el mensaje del commit siguiendo el estándar ConventionalCommits.

1.2.1. Casos de uso

  • Commit realizado correctamente: Para realizar un commit con éxito, el código debe tener el formato correcto. Gracias a esta biblioteca, podemos asegurarnos de que nuestro mensaje para el commit se adhiera al estándar seleccionado dentro del proyecto.
  • Realización del commit fallida: Cuando se intenta ejecutar una confirmación y el código no está formateado correctamente, el proceso de confirmación se cancelará. La consola mostrará los archivos que necesitan formato y las áreas específicas dentro de cada archivo que no se adhieren al formato de código establecido. No se realizará un commit con éxito hasta que sé de el formato correcto a los archivos que lo requieren.

Al existir un fichero con un formato incorrecto puede usar la biblioteca black para dar formato al codigo de manera automatica con el siguiente commando.

black api_inmobiliaria/

Luego agrega las modificaciones al aerea de confirmación de Git y podra realizar con exito el commit anterior.

Note

Si está utilizando VSCode, puede instalar la siguiente extensión para automatizar el formato del código aprovechando la configuración indicada en este repositorio. Name: Black Formatter Id: ms-python.black-formatter Description: Formatting support for Python files using the Black formatter. Publisher: Microsoft VS Marketplace Link: https://marketplace.visualstudio.com/items?itemName=ms-python.black-formatter

2. Principios de la Comunidad

Por favor sea respetuoso y considerado con los demás. Seguimos el Código de conducta del Pacto del colaborador.