Docs

Contribuir

Dónde pedir ayuda con el motor de código abierto, cómo reportar un error o enviar un cambio, y los términos bajo los que se acepta una contribución, incluida la firma en cada commit.

Aplica a Motor Al lanzar

Ver como Markdown
En esta página
  1. Dónde vive cada cosa
  2. Hacer una pregunta, reportar un error
  3. Enviar un cambio
  4. Abre primero un issue
  5. Cambia la documentación antes que el código
  6. Escribe el código con sus pruebas, y firma tus commits
  7. Abre el pull request
  8. Los términos de una contribución
  9. La firma
  10. Qué significa esto para ti y para nosotros
  11. Qué mira un mantenedor
  12. Relacionado

Motor Esta página es para quien quiere ayuda con las partes de código abierto de Sypnia, o quiere mejorarlas: el motor y su Consola, los SDK, @sypnia/mcp, las skills de agente y esta documentación. La app de Sypnia Cloud no es de código abierto y no recibe contribuciones; para Sypnia Cloud, ver Soporte.

Dónde vive cada cosa

QuéRepositorioLicencia
El motor, la Consola, las especificaciones, los archivos de desplieguegithub.com/sypnia/sypniaAGPL-3.0
Las skills de agentegithub.com/sypnia/skillsMIT
Los SDK y @sypnia/mcpEnlazado desde la página de cada paquete en npmMIT
Esta documentaciónEnlazado desde «Editar esta página» al final de cada página, cuando sea públicoCC BY 4.0

Hacer una pregunta, reportar un error

La ayuda para el motor de código abierto la da la comunidad, a la vista de todos, en el repositorio del motor. Nosotros lo leemos y respondemos cuando podemos; no hay un tiempo de respuesta prometido.

TienesDónde
Una pregunta sobre cómo correr o usar el motorLas discusiones del repositorio
Un errorEl registro de issues del repositorio
Una idea para un cambioUn issue, antes de cualquier código
Un problema de seguridadNo en público. Ver Reportar un problema de seguridad.

Un reporte de error que se arregla rápido tiene:

  1. La versión: la salida de sypnia version, y el nombre y la versión del SDK.
  2. El montaje: la salida de sypnia doctor. No imprime secretos.
  3. Qué esperabas y qué pasó, una frase para cada cosa.
  4. Cómo repetirlo. Para un número equivocado o una agrupación equivocada, el lote de eventos que lo muestra es el mejor reporte que hay.

Nunca pegues un token de API ni el token raíz. Una llave de ingesta es pública y se puede compartir.

Enviar un cambio

Sypnia se construye empezando por la documentación, y un cambio sigue el mismo orden. El flujo completo, con las revisiones que corren en cada pull request, está en El código. En corto:

  1. Abre primero un issue

    Di qué debería cambiar y por qué. Te ahorra escribir algo que no se puede integrar. Algunos cambios son decisiones, no código, y se resuelven en un issue: un nuevo servicio obligatorio, un cambio que partiría problemas existentes, una integración que envíe alertas a un producto de chat.

  2. Cambia la documentación antes que el código

    Si cambia el comportamiento, la página que lo describe cambia en el mismo pull request, y también el archivo de spec/ cuando se mueve un endpoint, un evento, un ajuste o un comando. Un cambio de comportamiento sin su cambio de documentación no se revisa.

  3. Escribe el código con sus pruebas, y firma tus commits

    Terminal
    git commit -s -m "Fix the p75 of an hour with no views"
    Deberías ver

    El mensaje del commit termina con tu firma:

    Text
    Fix the p75 of an hour with no views
    
    Signed-off-by: Ana Ruiz <ana@example.com>
  4. Abre el pull request

    Las revisiones automáticas tienen que pasar. Un mantenedor revisa, puede pedir cambios, y hace el merge.

Los arreglos pequeños a la documentación, como una errata, un enlace roto o una frase más clara, no necesitan issue. Cada página tiene una versión en inglés y una en español; cambia las dos, o di en el pull request que falta la otra, y alguien la escribe.

Los términos de una contribución

Son cortos a propósito.

  • Tu contribución toma la licencia del repositorio al que entra: AGPL-3.0 para el motor y la Consola, MIT para los SDK, @sypnia/mcp y las skills, CC BY 4.0 para la documentación. Lo que entra queda licenciado exactamente igual que lo que sale.
  • Conservas tus derechos de autor. No nos los entregas.
  • No hay un acuerdo de licencia de contribuidor que firmar. En su lugar, cada commit lleva una firma.

La firma

La línea Signed-off-by: Tu Nombre <tu@example.com> al final del mensaje de un commit dice que aceptas el Developer Certificate of Origin, versión 1.1. En palabras simples, declaras que:

  1. tú escribiste el cambio, o tienes derecho a enviarlo bajo la licencia del repositorio;
  2. si se apoya en el trabajo de otra persona, la licencia de ese trabajo lo permite;
  3. sabes que la contribución es pública y que se conserva, con tu nombre y tu correo, en el historial del proyecto.

Cómo hacerlo:

ParaCorre
Firmar un commit al hacerlogit commit -s
Agregar la firma a tu último commitgit commit --amend -s --no-edit
Agregarla a todos los commits de tu ramagit rebase --signoff main

Usa tu nombre, o el nombre por el que te conocen, y una dirección en la que se te pueda encontrar. Una revisión en cada pull request rechaza los commits sin firma.

Qué significa esto para ti y para nosotros

  • Nadie, tampoco nosotros, puede tomar tu contribución y ponerla bajo otra licencia. El motor sigue siendo AGPL para todos. Sypnia Cloud corre el motor tal como se publica.
  • Si lo que escribes le pertenece a tu empleador, asegúrate de que tienes permiso para contribuirlo. La firma es tu forma de decir que lo tienes.
  • El código escrito con ayuda de una herramienta de IA es bienvenido en los mismos términos. Lo firmas como cualquier otro cambio, así que léelo y asegúrate de que puedes enviarlo.
  • El código copiado de otro lugar tiene que venir bajo una licencia que encaje con la del repositorio, y el pull request tiene que decir de dónde viene.

Qué mira un mantenedor

Antes que el estilo o el gusto, las reglas del motor: toda escritura nueva puede correr dos veces sin daño, nada recibe un proyecto como una cadena suelta, ninguna entrada puede hacer que el motor entre en pánico, y una migración solo agrega. Están explicadas, con el código, en El código.

Sé específico y sé amable. La gente lee estos hilos en su tiempo libre, en su segundo idioma.

Relacionado

Secciones

Empieza aquíQué es Sypnia, cómo funciona, qué es código abierto y qué es la nube de pago, y las dos maneras de recibir tu primer problema en palabras claras.ConceptosLas diez ideas de las que está hecho Sypnia, cada una definida con precisión, desde un proyecto y sus llaves hasta los problemas, las trazas y las alertas.SDKCómo envía tu app los datos a Sypnia. Un SDK para el navegador, uno para Node, uno para Next.js, y la entrada de OpenTelemetry para cualquier otro backend.El agenteCómo analiza Sypnia un problema, qué escribe, qué le envía a un modelo y qué nunca hace.MCP y skillsConecta tu agente de código a Sypnia para que pregunte qué está fallando en producción, lea lo que necesita para arreglarlo y configure Sypnia por ti.Referencia de la APILa API HTTP de Sypnia: una sola API para el motor de código abierto y para Sypnia Cloud, con cada endpoint, parámetro, respuesta y error.Referencia de la CLIEl comando sypnia: cómo instalarlo, qué variables lee, qué significan sus códigos de salida y dónde está documentado cada comando.Alojamiento propioQué corres cuando alojas tú mismo el motor de Sypnia, qué necesitas, cuánto cuesta y qué no tienes frente a Sypnia Cloud.Cómo está construido el motorTodo el motor de Sypnia en una página, desde un clic en tu app hasta la frase que lee tu agente de código, con las reglas de diseño y el código que las sostiene.Sypnia CloudCómo funciona el servicio pago, desde las organizaciones y los roles hasta los planes, los límites, la facturación, dónde viven tus datos, la GitHub App y el soporte.Privacidad y seguridadQué recoge Sypnia de tu app y de sus usuarios, qué no recoge nunca, cómo funciona el enmascarado, cómo eliminar datos y cómo se protege el servicio.LicenciasQué licencia cubre cada parte de Sypnia, qué puedes hacer con ella, cómo se puede usar el nombre, y los términos de una contribución.GuíasRecetas paso a paso para las formas comunes de usar Sypnia, desde apps hechas con constructores de IA y Next.js en Vercel hasta Supabase, source maps en CI, correos de alerta desde tu propio motor, y venir desde Sentry.ReferenciaLas páginas donde se consulta, desde el esquema de eventos y el glosario hasta lo planeado, el registro de cambios y las preguntas frecuentes.
↑↓ para moverte↵ para abrirEsc para cerrar