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.
En esta página
- Dónde vive cada cosa
- Hacer una pregunta, reportar un error
- Enviar un cambio
- Abre primero un issue
- Cambia la documentación antes que el código
- Escribe el código con sus pruebas, y firma tus commits
- Abre el pull request
- Los términos de una contribución
- La firma
- Qué significa esto para ti y para nosotros
- Qué mira un mantenedor
- 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é | Repositorio | Licencia |
|---|---|---|
| El motor, la Consola, las especificaciones, los archivos de despliegue | github.com/sypnia/sypnia | AGPL-3.0 |
| Las skills de agente | github.com/sypnia/skills | MIT |
Los SDK y @sypnia/mcp | Enlazado desde la página de cada paquete en npm | MIT |
| Esta documentación | Enlazado desde «Editar esta página» al final de cada página, cuando sea público | CC 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.
| Tienes | Dónde |
|---|---|
| Una pregunta sobre cómo correr o usar el motor | Las discusiones del repositorio |
| Un error | El registro de issues del repositorio |
| Una idea para un cambio | Un issue, antes de cualquier código |
| Un problema de seguridad | No en público. Ver Reportar un problema de seguridad. |
Un reporte de error que se arregla rápido tiene:
- La versión: la salida de
sypnia version, y el nombre y la versión del SDK. - El montaje: la salida de
sypnia doctor. No imprime secretos. - Qué esperabas y qué pasó, una frase para cada cosa.
- 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:
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.
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/mcpy 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:
- tú escribiste el cambio, o tienes derecho a enviarlo bajo la licencia del repositorio;
- si se apoya en el trabajo de otra persona, la licencia de ese trabajo lo permite;
- 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:
| Para | Corre |
|---|---|
| Firmar un commit al hacerlo | git commit -s |
| Agregar la firma a tu último commit | git commit --amend -s --no-edit |
| Agregarla a todos los commits de tu rama | git 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
- Los crates, las reglas del código, cómo correrlo en tu máquina.
-
Las licencias en palabras simples
Qué te deja hacer cada licencia. - Lo que todavía no está hecho, y puede ser un buen lugar para ayudar.