Contribuir a Zoo Code

Zoo Code es un proyecto impulsado por la comunidad y valoramos profundamente cada contribución. Para agilizar la colaboración, operamos con un enfoque de "primero la incidencia", lo que significa que todas las solicitudes de extracción (PR) deben estar primero vinculadas a una incidencia de GitHub. Por favor, revise esta guía detenidamente.

Tabla de contenidos

• Antes de contribuir
• Encontrar y planificar su contribución
• Proceso de desarrollo y envío
• Expectativas de las solicitudes de extracción
• Contribuciones asistidas por IA
• Legal

Antes de contribuir

1. Código de conducta

Todos los colaboradores deben adherirse a nuestro Código de conducta.

2. Hoja de ruta del proyecto

Nuestra hoja de ruta guía la dirección del proyecto. Alinee sus contribuciones con estos objetivos clave:

La fiabilidad es lo primero

• Asegúrese de que la edición de diferencias y la ejecución de comandos sean consistentemente fiables.
• Reduzca los puntos de fricción que desalientan el uso regular.
• Garantice un funcionamiento fluido en todas las localidades y plataformas.
• Amplíe el soporte robusto para una amplia variedad de proveedores y modelos de IA.

Experiencia de usuario mejorada

• Agilice la interfaz de usuario/experiencia de usuario para mayor claridad e intuición.
• Mejore continuamente el flujo de trabajo para cumplir con las altas expectativas que los desarrolladores tienen de las herramientas de uso diario.

Liderando el rendimiento de los agentes

• Establezca puntos de referencia de evaluación (evals) exhaustivos para medir la productividad en el mundo real.
• Facilite que todos puedan ejecutar e interpretar fácilmente estas evaluaciones.
• Envíe mejoras que demuestren un claro aumento en las puntuaciones de las evaluaciones.

Mencione la alineación con estas áreas en sus solicitudes de extracción.

3. Únete a la comunidad de Zoo Code

• Discord: Únete a nuestro Discord.
• Reddit: Únete a nuestro Reddit.

Encontrar y planificar su contribución

Tipos de contribuciones

• Correcciones de errores: abordar problemas de código.
• Nuevas características: agregar funcionalidad.
• Documentación: mejorar las guías y la claridad.

Enfoque de primero la incidencia

Todas las contribuciones comienzan con una incidencia de GitHub utilizando nuestras plantillas simplificadas.

• Compruebe las incidencias existentes: busque en Incidencias de GitHub.
• Cree una incidencia utilizando:
  • Mejoras: plantilla "Solicitud de mejora" (lenguaje sencillo centrado en el beneficio del usuario).
  • Errores: plantilla "Informe de error" (reproducción mínima + esperado vs. real + versión).
• ¿Quiere trabajar en ello? Comente "Reclamando" en la incidencia y envíe un mensaje directo al equipo principal en Discord para que se le asigne. La asignación se confirmará en el hilo.
• Las solicitudes de extracción deben enlazar a la incidencia. Las solicitudes de extracción no enlazadas pueden cerrarse.

Decidir en qué trabajar

• Consulta la página de GitHub Issues para ver las issues.
• Para la documentación, visite Documentos de Zoo Code.

Informar de errores

• Compruebe primero si existen informes.
• Cree un nuevo error utilizando la plantilla "Informe de error" con:
  • Pasos de reproducción claros y numerados
  • Resultado esperado vs. real
  • Versión de Zoo Code (obligatorio); proveedor/modelo de API si es relevante
• Problemas de seguridad: informe de forma privada a través de avisos de seguridad.

Proceso de desarrollo y envío

Configuración de desarrollo

1. Bifurcar y clonar:

git clone https://github.com/YOUR_USERNAME/Zoo-Code.git

2. Instalar dependencias:

pnpm install

3. Depuración: Abra con VS Code (F5).

Directrices para escribir código

• Una solicitud de extracción centrada por característica o corrección.
• Siga las mejores prácticas de ESLint y TypeScript.
• Escriba confirmaciones claras y descriptivas que hagan referencia a las incidencias (p. ej., Corrige #123).
• Proporcione pruebas exhaustivas (npm test).
• Rebase a la rama main más reciente antes del envío.

Envío de una solicitud de extracción

• Comience como una PR en borrador si busca comentarios tempranos.
• Describa claramente sus cambios siguiendo la plantilla de solicitud de extracción.
• Enlace la incidencia en la descripción/título de la PR (p. ej., "Corrige #123").
• Proporcione capturas de pantalla/vídeos para los cambios en la interfaz de usuario.
• Indique si es necesario actualizar la documentación.

Política de solicitud de extracción

• Debe hacer referencia a una incidencia de GitHub asignada. Para que se le asigne: comente "Reclamando" en la incidencia y envíe un mensaje directo al equipo principal en Discord. La asignación se confirmará en el hilo.
• Las solicitudes de extracción no enlazadas pueden cerrarse.
• Las solicitudes de extracción deben pasar las pruebas de CI, estar alineadas con la hoja de ruta y tener una documentación clara.

Proceso de revisión

• Clasificación diaria: comprobaciones rápidas por parte de los mantenedores.
• Revisión semanal en profundidad: evaluación exhaustiva.
• Itere rápidamente en función de los comentarios.

Expectativas de las solicitudes de extracción

Las solicitudes de extracción deben ser revisables, probadas y mantenibles. Antes de abrir una PR, asegúrese de que:

• El cambio se limita a un problema, error o mejora específicos.
• Puede explicar qué hace el cambio y por qué es correcto.
• Ha probado el cambio localmente donde sea práctico.
• Está dispuesto a responder a los comentarios de revisión y realizar cambios de seguimiento razonables.
• La PR no requiere que los mantenedores reescriban, rediseñen o asuman sustancialmente la propiedad de la implementación antes de poder fusionarla.

Los mantenedores pueden cerrar PRs que estén incompletas, sean demasiado amplias, inactivas, no estén alineadas con la dirección del proyecto o que creen una carga desproporcionada de revisión o mantenimiento. Cerrar una PR no es un juicio sobre el colaborador; es una decisión de los mantenedores de que el cambio no puede aceptarse en su forma actual.

Contribuciones asistidas por IA

El uso de herramientas de IA está permitido, pero los colaboradores siguen siendo completamente responsables de sus aportaciones.

Si utiliza herramientas de IA para ayudar a crear una PR, debe:

• Revisar y comprender cada cambio significativo.
• Ser capaz de explicar la implementación y las compensaciones con sus propias palabras.
• Probar el cambio usted mismo. Si las pruebas no son prácticas en su entorno, explique por qué en la descripción de la PR y describa cómo los revisores pueden verificar el cambio.
• Verificar que el código generado sea correcto, necesario y compatible con la licencia del proyecto.
• Considere revelar la asistencia de IA en la descripción de la PR cuando haya influido materialmente en el código, las pruebas o el diseño — esto ayuda a los revisores a dar mejor retroalimentación.

Por favor, no envíe cambios generados por IA que no entienda o que no pueda mantener durante la revisión. Los mantenedores pueden cerrar las PRs que parezcan sustancialmente asistidas por IA pero que carezcan de verificación humana, justificación clara o seguimiento de la revisión.

Legal

Al contribuir, acepta que sus contribuciones se licenciarán bajo la Licencia Apache 2.0, de acuerdo con la licencia de Zoo Code.