Guía del contribuyente

Recientemente nos mudamos de Only Dust a GrantFox: https://www.grantfox.xyz/

¡Bienvenido a la comunidad de código abierto de Trustless Work! 🚀 Agradecemos tu interés en contribuir y ayudarnos a construir Infraestructura de escrow para la Nueva Economía. Esta guía te guiará a través del proceso para contribuir de manera efectiva.

Una vez asignada una tarea, por favor sigue estas pautas:

🔹 1. Primeros pasos

Fork y Clona el Repositorio

  1. Fork el repositorio en GitHub.

  2. Clona tu repositorio bifurcado a tu máquina local:

    git clone https://github.com/YOUR_USERNAME/REPOSITORY_NAME.git
cd REPOSITORY_NAME

  3. Configura el remoto upstream para sincronizar con el repositorio principal:

    git remote add upstream https://github.com/TrustlessWork/REPOSITORY_NAME.git

  4. Asegúrate de estar en la versión más reciente de develop:

    git checkout develop
git pull upstream develop

🔹 2. Estrategia de ramas

Seguimos un modelo de branching estructurado para mantener las contribuciones organizadas.

Ramas principales

  • main → La lista para producción rama (NO hagas push aquí directamente).

  • develop → La desarrollo activo rama donde se fusionan las características.

Ramas de características y correcciones

Crea una rama según el tipo de cambio:

  • Características: feat/nombre-de-la-característica

    • Ejemplo: feat/escrow-ui

  • Correcciones de errores: fix/descripcion-del-error

    • Ejemplo: fix/api-response-error

  • Documentación: docs/nombre-de-actualizacion

    • Ejemplo: docs/guia-de-comienzo

  • Refactorización: refactor/mejora-de-codigo

    • Ejemplo: refactor/limpiar-smart-contracts

Crea una nueva rama

Siempre crea una nueva rama antes de hacer cambios:

   git checkout develop
   git pull upstream develop  # Sincroniza con el código más reciente
   git checkout -b feat/new-feature

🔹 3. Realizar contribuciones

Estándares de codificación

✅ Mantén los cambios pequeños y atómicos. ✅ Sigue las pautas de mensajes de commit (ver más abajo). ✅ Asegúrate de que las pruebas pasen antes de enviar un PR. ✅ Formatea el código usando nuestras reglas de linting y formateo.

Pautas para mensajes de commit

Usa un formato de mensaje claro y conciso:

tipo: descripción breve (menos de 72 caracteres)

Ejemplos:

  • feat: añadir sistema de aprobación de escrow

  • fix: resolver problema de timeout en la API

  • docs: actualizar README con instrucciones de configuración

Tipos:

  • feat: Nueva característica

  • fix: Corrección de error

  • docs: Actualización de documentación

  • refactor: Reestructuración de código

  • style: Formateo de código (sin cambios de lógica)

  • test: Añadir o actualizar pruebas

  • build: Cambios en el proceso de construcción o dependencias

  • ci: Cambios en la configuración de CI/CD

  • chore: Actualizaciones varias

🔹 4. Enviar cambios y crear un PR

Envía tus cambios

   git add .
   git commit -m "feat: add escrow approval system"
   git push origin feat/new-feature

Crear un Pull Request (PR)

  1. Ve al repositorio original en GitHub.

  2. Haz clic Nuevo Pull Request.

  3. Selecciona develop como la rama base y tu rama de característica como la rama a comparar.

  4. Proporciona una descripción clara de los cambios.

  5. ¡Envía para revisión!

🔹 5. Proceso de revisión de código y fusión

✅ Los mantenedores revisarán el PR y darán retroalimentación. ✅ Si se solicita, realiza cambios y sube actualizaciones a tu PR. ✅ Una vez aprobado, el PR se fusiona en develop. ✅ Después de las pruebas, develop se fusiona en main para producción.

🔹 6. Recursos adicionales

📖 Trustless Work en GitHub – Explora nuestros repositorios. 💬 Únete a nuestro Telegram – Conéctate con otros contribuidores.

¡Feliz codificación! 🎉

AnteriorEcosistemaSiguienteEnlaces interesantes

Última actualización

¿Te fue útil?