mirror of
https://github.com/snapotter-hq/SnapOtter.git
synced 2026-08-03 07:46:42 +02:00
SnapOtterandGitHub
d10d0f544f
A release-readiness QA pass over the whole product. The commits split into defects a user would hit and gates that were reporting green while measuring nothing. ## Fixes that change behaviour Rate limiting was bypassable on every install: TRUST_PROXY defaulted to true, so request.ip came from a client-set header and a forged X-Forwarded-For got past the login limiter. The default is now a private-network trust list. A transient Postgres outage stranded in-flight jobs, leaving finished output on disk with no row pointing at it. A reconciler now resolves those rows and adopts the bytes rather than dropping the work. A Redis connection that moved to a new address wedged every read-blocked consumer, so completions stopped signalling while health still answered 200. Socket timeouts plus subscriber pings recover it. Installing more than one AI bundle left the shared venv multi-versioned and silently broke three tools. The installer now reconciles distributions to one version each. Converting an image to JXL at quality 1 through 4 returned a 500, because libjxl 0.7 rejects the distance those values compute. The quality is floored at what the encoder honours. A missing ffmpeg was also reported to the user as a corrupt upload; it now says the engine is unavailable. RAW uploads reached an unpatched LibRaw on arm64, so it is built from source at 0.22.2, and the release scan was split so it can fail on an unfixed critical instead of hiding it behind ignore-unfixed. ## Gates that could not fail Two mutation lanes ran zero mutants because Stryker crawled the gitignored docs build; coverage discarded its whole report on any failing test; the lint gate skipped root tests, scripts, and two workspaces; and several generated matrices counted a host missing ffmpeg as a passing tool. Each now measures what it claims. Full evidence and the outstanding release items are tracked locally and are not part of this branch.
133 lines
6.8 KiB
Markdown
133 lines
6.8 KiB
Markdown
---
|
|
description: "Cómo contribuir a SnapOtter. Informes de errores, solicitudes de funciones, pull requests y requisitos del CLA."
|
|
i18n_source_hash: 6c920a5f83e0
|
|
i18n_provenance: human
|
|
i18n_output_hash: 406a2e39b199
|
|
i18n_hash_version: 2
|
|
---
|
|
|
|
# Contribuir {#contributing}
|
|
|
|
Gracias por tu interés en contribuir. Esta guía cubre cómo participar, qué aceptamos y cómo empezar.
|
|
|
|
## Formas de contribuir {#ways-to-contribute}
|
|
|
|
### Issues (sin configuración) {#issues-no-setup-required}
|
|
|
|
- **Informes de errores** - ¿Algo no funciona? Abre un [informe de error](https://github.com/snapotter-hq/snapotter/issues/new?template=bug_report.yml) con los pasos para reproducirlo.
|
|
- **Solicitudes de funciones** - ¿Tienes una idea? Inicia una [discusión](https://github.com/snapotter-hq/snapotter/discussions/new?category=ideas) para que la comunidad opine y la vote.
|
|
- **Problemas de traducción** - ¿Detectas una traducción incorrecta o faltante? Abre un [issue de traducción](https://github.com/snapotter-hq/snapotter/issues/new?template=translation.yml).
|
|
- **Problemas de documentación** - ¿Algo raro en la documentación? Abre un [issue de documentación](https://github.com/snapotter-hq/snapotter/issues/new?template=documentation.yml).
|
|
|
|
### Código (requiere CLA) {#code-requires-cla}
|
|
|
|
Aceptamos pull requests para:
|
|
|
|
| Tipo | Proceso |
|
|
|------|---------|
|
|
| Correcciones de errores | Abre un PR directamente (enlaza el issue si existe) |
|
|
| Nuevas traducciones | Abre un PR directamente (consulta la [Guía de traducción](/es/guide/translations)) |
|
|
| Mejoras de documentación | Abre un PR directamente |
|
|
| Mejoras en la cobertura de pruebas | Abre un PR directamente |
|
|
| Nuevas herramientas o funciones | Inicia primero una [discusión](https://github.com/snapotter-hq/snapotter/discussions/new?category=ideas); un mantenedor convierte las ideas aprobadas en un issue con seguimiento antes de que escribas código |
|
|
| Refactorizaciones o cambios de arquitectura | Inicia primero una [discusión](https://github.com/snapotter-hq/snapotter/discussions/new?category=ideas) y espera la aprobación de un mantenedor antes de escribir código |
|
|
|
|
### Lo que no aceptaremos {#what-we-will-not-accept}
|
|
|
|
- Cambios en los flujos de trabajo de CI/CD, la configuración de release o la configuración del linter/compilador
|
|
- PRs sin un [Acuerdo de Licencia de Contribuidor](#contributor-license-agreement) firmado
|
|
- PRs con más de 400 líneas de cambios (divide el trabajo grande en PRs más pequeños)
|
|
- Funciones que no se hayan discutido y aprobado antes
|
|
- Cambios en `packages/ai/` sin discusión previa
|
|
|
|
## Acuerdo de Licencia de Contribuidor {#contributor-license-agreement}
|
|
|
|
Antes de poder fusionar tu primer PR, debes firmar nuestro [CLA Individual](https://github.com/snapotter-hq/snapotter/blob/main/CLA.md). Es un requisito único.
|
|
|
|
**Por qué:** SnapOtter tiene licencia dual (AGPLv3 + comercial). El CLA nos otorga el derecho a distribuir tus contribuciones bajo ambas licencias. Conservas la plena titularidad de los derechos de autor sobre tu trabajo.
|
|
|
|
**Cómo:** Cuando abras tu primer PR, el bot CLA Assistant comentará con un enlace. Haz clic en él, revisa el acuerdo y fírmalo con tu cuenta de GitHub. Tarda 30 segundos.
|
|
|
|
Si contribuyes en nombre de tu empleador y este conserva los derechos de propiedad intelectual sobre tu trabajo, contacta con contact@snapotter.com para gestionar un CLA Corporativo antes de enviar tu contribución.
|
|
|
|
## Cómo empezar {#getting-started}
|
|
|
|
### Requisitos previos {#prerequisites}
|
|
|
|
- Node.js 22.22+
|
|
- pnpm 9+
|
|
- Python 3.11+ (solo para herramientas de IA)
|
|
- Docker (opcional, para pruebas de integración completas)
|
|
|
|
### Configuración {#setup}
|
|
|
|
```bash
|
|
# Fork and clone
|
|
git clone https://github.com/<your-username>/snapotter.git
|
|
cd snapotter
|
|
|
|
# Start Postgres + Redis for local dev
|
|
docker compose -f docker-compose.dev.yml up -d
|
|
|
|
# Install dependencies
|
|
pnpm install
|
|
|
|
# Start dev servers (web on :1351, API on :13490)
|
|
pnpm dev
|
|
```
|
|
|
|
### Ejecutar comprobaciones {#running-checks}
|
|
|
|
Antes de enviar un PR, asegúrate de que todas las comprobaciones pasen localmente:
|
|
|
|
```bash
|
|
pnpm lint # Biome lint + format check
|
|
pnpm typecheck # TypeScript across monorepo
|
|
pnpm test # Vitest unit + integration tests
|
|
```
|
|
|
|
## Proceso de pull request {#pull-request-process}
|
|
|
|
1. Haz un fork del repositorio y crea una rama a partir de `main` (`feat/my-feature` o `fix/issue-123`)
|
|
2. Realiza tus cambios en commits enfocados y revisables usando [conventional commits](https://www.conventionalcommits.org/)
|
|
3. Añade o actualiza pruebas para tus cambios
|
|
4. Ejecuta `pnpm lint && pnpm typecheck && pnpm test` localmente
|
|
5. Abre un PR contra `main` y rellena la plantilla
|
|
6. Firma el CLA si se te solicita
|
|
7. Espera a que CI pase y a que un mantenedor lo revise
|
|
|
|
### Qué esperar de la revisión {#review-expectations}
|
|
|
|
- Intentamos responder a los PRs en un plazo de 7 días
|
|
- Los PRs pequeños y enfocados se revisan más rápido
|
|
- Si no recibes respuesta en 7 días, deja un comentario mencionando el hilo
|
|
- Podemos solicitar cambios, sugerir un enfoque diferente o cerrar el PR si no encaja con la dirección del proyecto
|
|
|
|
### Después de que se fusione tu PR {#after-your-pr-is-merged}
|
|
|
|
Tu contribución se incluirá en la siguiente versión y se acreditará en el changelog.
|
|
|
|
## Buenos primeros issues {#good-first-issues}
|
|
|
|
¿Buscas en qué trabajar? Revisa nuestros [good first issues](https://github.com/snapotter-hq/snapotter/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22) para tareas aptas para principiantes, o [help wanted](https://github.com/snapotter-hq/snapotter/issues?q=is%3Aissue+is%3Aopen+label%3A%22help+wanted%22) para tareas más grandes en las que agradeceríamos la ayuda de la comunidad.
|
|
|
|
## Estilo de código {#code-style}
|
|
|
|
- Biome se encarga del formato y el linting (comillas dobles, punto y coma, indentación de 2 espacios)
|
|
- El hook de pre-commit ejecuta `biome check --write` automáticamente sobre los archivos en staging
|
|
- Si el linter se queja, corrige el código (no modifiques la configuración de Biome)
|
|
- Módulos ES en todas partes (`import`/`export`)
|
|
- Conventional commits: `feat:`, `fix:`, `refactor:`, `docs:`, `test:`, `chore:`
|
|
|
|
Para los detalles completos de la arquitectura, consulta la [Guía del desarrollador](/es/guide/developer).
|
|
|
|
## Seguridad {#security}
|
|
|
|
**No abras un PR o issue público para vulnerabilidades de seguridad.** Repórtalas de forma privada a través de [GitHub Security Advisories](https://github.com/snapotter-hq/snapotter/security/advisories/new) o por correo a contact@snapotter.com. Consulta [SECURITY.md](https://github.com/snapotter-hq/snapotter/blob/main/SECURITY.md) para todos los detalles.
|
|
|
|
## ¿Preguntas? {#questions}
|
|
|
|
- [Documentación](https://docs.snapotter.com/)
|
|
- [Discord](https://discord.gg/hr3s7HPUsr)
|
|
- [GitHub Discussions](https://github.com/snapotter-hq/snapotter/discussions)
|