kamp/pingvin-share
1
0
Fork 0
mirror of https://github.com/stonith404/pingvin-share.git synced 2024-11-05 07:20:13 +01:00
Code
4df8dea5cc
pingvin-share/docs/CONTRIBUTING.es.md
Elias Schneider b4bf43910e
docs: move translated docs in docs folder
2023-04-02 18:53:54 +02:00

3.0 KiB
Raw Blame History

Leer esto en otro idioma: Inglés, Español, Chino Simplificado

Contribuyendo

¡Nos ❤️ encantaría que contribuyas a Pingvin Share y nos ayudes a hacerlo mejor! Todas las contribuciones son bienvenidas, incluyendo problemas, sugerencias, pull requests y más.

Para comenzar

Si encontraste un error, tienes una sugerencia o algo más, simplemente crea un problema (issue) en GitHub y nos pondremos en contacto contigo 😊.

Para hacer una Pull Request

Antes de enviar la pull request para su revisión, asegúrate de que:

  • El nombre de la pull request sigue las especificaciones de Commits Convencionales:

    <tipo>[ámbito opcional]: <descripción>

    ejemplo:

    feat(share): agregar protección con contraseña

    Donde tipo puede ser:

    • feat - es una nueva función
    • doc - cambios solo en la documentación
    • fix - una corrección de error
    • refactor - cambios en el código que no solucionan un error ni agregan una función

  • Tu pull requests tiene una descripción detallada.

  • Ejecutaste npm run format para formatear el código.

¿No sabes como crear una pull request? Aprende cómo crear una pull request

  1. Crea un fork del repositorio haciendo clic en el botón Fork en el repositorio de Pingvin Share.

  2. Clona tu fork en tu máquina con git clone.

$ git clone https://github.com/[your_username]/pingvin-share

  1. Trabajar - hacer commit - repetir

  2. Haz un push de tus cambios a GitHub.

$ git push origin [nombre_de_tu_nueva_rama]
  1. Envía tus cambios para su revisión. Si vas a tu repositorio en GitHub, verás un botón Comparar y crear pull requests. Haz clic en ese botón.
  2. Inicia una Pull Request
  3. Ahora envía la pull requests y haz clic en Crear pull requests
  4. Espera a que alguien revise tu solicitud y apruebe o rechace tus cambios. Puedes ver los comentarios en la página de la solicitud en GitHub.

Instalación del proyecto

Pingvin Share consiste de un frontend y un backend.

Backend

El backend está hecho con Nest.js y usa Typescript.

Instalación

  1. Abrimos la carpeta backend
  2. Instalamos las dependencias con npm install
  3. Haz un push del esquema de la base de datos a la base de datos ejecutando npx prisma db push
  4. Rellena la base de datos ejecutando npx prisma db seed
  5. Inicia el backend con npm run dev

Frontend

El frontend está hecho con Next.js y usa Typescript.

Instalación

  1. Primero inicia el backend
  2. Abre la carpeta frontend
  3. Instala las dependencias con npm install
  4. Inicia el frontend con npm run dev

¡Ya está todo listo!

Testing

Por el momento, solo tenemos pruebas para el backend. Para ejecutar estas pruebas, debes ejecutar el comando npm run test:system en la carpeta del backend.