Skip to content

Latest commit

 

History

History
51 lines (30 loc) · 3.04 KB

CONTRIBUTING.md

File metadata and controls

51 lines (30 loc) · 3.04 KB

Guía de contribución de IA²-Api-Backend

¡Hola! Estamos muy emocionadxs de que estes interesadx en contribuir a IA2-Api-Backend. Antes de enviar Pull Requests, asegurate de tomarte un momento y leer las siguientes pautas:

Pautas para la apertura de issues

  • Utiliza siempre nuestros templates de issue para bugs o para features para crear issues.

Pautas para la apertura de Pull Requests

  • La rama main es solo un snapshot de la última versión estable. Todo el desarrollo debe realizarse en ramas dedicadas que apunten a la rama develop. No envíes PRs contra la rama main.

  • Siempre realizar un checkout partiendo de la rama en cuestión, ej: develop y realizar el merge contra esa misma rama al finalizar. Siga esta convención para la nueva rama: númeroDeIssue-usuarioDeGithub-títuloDeCommit.

  • Esta bien realizar varios commit pequeños mientras trabajas en el PR. Podemos realizar un squash antes de mergear la rama, si es necesario.

  • Si agregas una nueva característica:

    • Agrega un caso de prueba
    • Proporciona una razón convincente para agregar esta función. Idealmente, primero debes abrir un issue comentando la sugerencia y aguardar que se apruebe antes de trabajar en él.

  • Si arreglas un bug:

    • Si estas resolviendo un caso especial sigue la convención de nomenclatura de ramas mencionada anteriormente.
    • Proporciona una descripción detallada de la resolución del bug en el PR. Se prefiere una demostración en vivo.

Configuración de desarrollo

Necesitarás Python versión 3.7.6 o posterior o Docker con Docker Compose.

Después de clonar el repositorio forkeado, sigue las instrucciones de desarrollo en README.md

Escritura de commits

No esperamos ninguna convención estricta, pero agradeceríamos que resumieras de qué trata el contenido de tus modificaciones al escribir un commit.

Estructura del proyecto

  • .env: archivo de configuración general del proyecto.

  • apps: <DIR> contiene los contextos relacionados al dominio del proyecto, que incluyen las vistas de los endpoints, el modelo relacional, las vistas de administración, tests, etc. Por ejemplo: accounts (autorización), entity (entidades de un modelo).

  • ia2: <DIR> Configuración principal del proyecto. En este directorio se encuentran las dependencias, configuración del router, configuración de celery.

  • ia2/settings: <DIR> Archivos de configuración de los ambientes: base, local, test y producción.

  • docker: <DIR> directorio dedicado a las configuraciones de docker del ambiente local de desarrollo.