1.6 KiB
1.6 KiB
Cómo contribuir
¡Gracias por querer ayudar! El proyecto se mantiene gracias a la comunidad.
Antes de empezar
- Mira los issues abiertos, sobre todo los marcados
good first issue. - Si tu cambio es grande, abre un issue antes de programar para discutirlo.
Flujo
- Haz fork del repositorio.
- Crea una rama desde
main:git checkout -b mi-cambio. - Escribe el código siguiendo las pautas de abajo.
- Asegúrate de que la app arranca:
npm install && npm run dev. - Abre un Pull Request hacia
maindescribiendo el cambio.
Pautas de código
- Mantén la app simple. Si dudas entre dos soluciones, elige la más corta y obvia. Este proyecto evita la complejidad a propósito.
- Sigue la estructura existente. Componentes en
src/components, acceso a datos ensrc/services. - No añadas dependencias sin necesidad. Cada nueva librería es coste de mantenimiento.
- SOLID y Clean Code aplicados con sentido común. Nombres claros, funciones cortas, una responsabilidad por archivo.
- Estilo: 2 espacios de indentación, comillas dobles en JSX y simples en JS.
Tipos de contribución
- Código: bugs, mejoras, nuevas funciones acordadas en issues.
- Documentación: cualquier archivo de
docs/o el README. - Diseño: propuestas en issues con mockups.
- Reportar negocios: usa la propia aplicación; no es necesario un PR.
Revisión
Un mantenedor revisará tu PR. Puede pedir cambios. Una vez aprobado, hará merge. Sé paciente: somos voluntarios.
Reconocimiento
Todas las personas que han contribuido aparecen automáticamente en la pestaña de Contributors del repositorio.