Skip to content

Latest commit

 

History

History
105 lines (69 loc) · 4.05 KB

README.md

File metadata and controls

105 lines (69 loc) · 4.05 KB
Raw

Truquito App

Este proyecto es de utilidades para el juego Truco y está desarrollado con Next.js. Para obtener más información sobre el juego, consulta Wikipedia Truco.

Comunidad de Discord 🌐

Únete a nuestra comunidad en Discord para participar en conversaciones, colaborar en el desarrollo y discutir sobre diferentes aspectos del proyecto.

Enlace de Discord: Únete a la Comunidad de TRUQUITO APP

No dudes en unirte a los canales que te interesen y participar activamente. ¡Esperamos verte allí! 🚀

Colabora con código 🤝💻

Si deseas contribuir con código, por favor:

  1. Haz un fork del Proyecto.
  2. Clona tu fork .
  3. Añade el repositorio original como remoto: git remote add upstream https://github.com/ramiro-l/truquito-app
  4. Crea tu Rama de Funcionalidad: git checkout -b feature/CaracteristicaIncreible
  5. Realiza tus cambios y seguí las convenciones para los commits.
  6. Asegúrate de seguir las directrices de estilo existentes.
  7. Haz Push a la Rama: git push origin feature/CaracteristicaIncreible
  8. Abre una pull request a la rama dev con una descripción detallada de los cambios propuestos y referencia al problema relacionado.

Important

  1. Unirse a la comunidad de Discord
  2. Revisa los issues abiertos o crea uno nuevo explicando la mejora o el error que deseas corregir.

Note

  1. En caso de error al crear los commits ejecutar pnpm run format porque se esta usando husky para garantizar la consistencia en los estilos.
  2. En caso de no lograr solucionar los errores, pide ayuda en la comunidad de discord.

Contribuye con ideas, errores o comentarios 💡

Si tienes una idea, encuentras un error o deseas dar feedback sobre el proyecto:

  • Abre un nuevo problema en el repositorio describiendo tu idea, el error que encontraste o el feedback que deseas compartir.

  • Sé lo más detallado posible en la descripción.

  • Si es posible, incluye capturas de pantalla u otros recursos que puedan ayudar a entender mejor tu punto.

Formato de los Commits 📝

Las convenciones de commit utilizadas en este proyecto son las siguientes:

  • Tipo de Commit: El tipo de commit proporciona contexto sobre el cambio realizado. Algunos ejemplos comunes incluyen feat para nuevas características, fix para correcciones de errores y docs para cambios en la documentación.

  • Ámbito Opcional: El ámbito proporciona información adicional sobre el alcance del cambio, como el módulo o componente afectado.

  • Descripción del Cambio: La descripción del cambio debe ser breve pero descriptiva, proporcionando suficiente información para entender el propósito del commit.

Ejemplo de un commit siguiendo estas convenciones:

feat(login): add email validation

Important

Este proyecto sigue los Conventional Commits para mantener un historial claro y consistente de cambios.

Para obtener más información sobre Commits Convencionales, consulta la web oficial.
Aquí tienes Conventional Commits para VSCode.

Instalación y Ejecución 🛠️

Asegúrate de tener Node.js instalado en tu máquina.

  1. Clona este repositorio:
   git clone https://github.com/ramiro-l/truquito-app.git
  1. Navega al directorio del proyecto:
   cd truquito-app
  1. Instala las dependencias:
   pnpm install
  1. Inicia la aplicación:
   pnpm run dev
  1. La aplicación estará disponible en localhost:3000.

Note

Puedes usar npm o yarn en lugar de pnpm si lo prefieres. Tener cuidado con husky, esta utilizando pnpm.