Contribuir

Antes que nada, ¡gracias por considerar contribuir a YAMLResume! Son personas como tú las que hacen que el código abierto sea genial. Damos la bienvenida a cualquier tipo de contribución, no solo código. Puedes ayudar con:

Reportar un error
Discutir el estado actual del código
Enviar una corrección
Proponer nuevas características
Mejorar la documentación

Aquí hay algunos atajos para algunos trabajos específicos:

CLI

Construir y Probar CLI

Docker

Personalización de Docker

Test

Pruebas y Aseguramiento de Calidad

Nuevo Idioma

Agregar soporte para un nuevo idioma en YAMLResume.

Empezando

Prerequisitos

Node.js (versión >= 20, verifica .nvmrc o campo engines de package.json)
pnpm (versión >= 10, verifica campo packageManager de package.json)
Git

Configuración

Hacer fork del repositorio: Haz clic en el botón "Fork" en la página de GitHub de YAMLResume. Esto crea tu propia copia del proyecto.

Clonar tu fork:

git clone https://github.com/<tu-usuario>/yamlresume.git
cd yamlresume

Instalar dependencias:
```
pnpm install
```
Este comando instala todas las dependencias necesarias para todo el workspace.

Flujo de Trabajo de Desarrollo

Construir Paquetes

Construir todos los paquetes una vez:
```
pnpm build
```
Construir todos los paquetes y vigilar cambios:
```
pnpm build:watch
```
Construir para producción (incluyendo definiciones de tipos, minificación):
```
pnpm build:prod
```

Ejecutar Pruebas

Ejecutar pruebas para todos los paquetes:
```
pnpm test
```
Ejecutar pruebas en modo vigilancia:
```
pnpm test:watch
```
Ejecutar pruebas con reporte de cobertura:
```
pnpm test:cov
```

Consulta Test para más detalles y casos de uso.

Formato de Código y Linting

Usamos Biome para formato de código y linting. Asegúrate de que tu código se adhiere a las guías de estilo del proyecto antes de hacer commit.

Verificar y corregir automáticamente problemas:
```
pnpm check
```
Ejecutar verificaciones sin aplicar correcciones (útil para CI):
```
pnpm check:ci
```

También usamos addlicense para asegurar que los archivos fuente tengan el encabezado de licencia correcto. Necesitas instalarlo para ejecutar los siguientes comandos.

Agregar encabezados de licencia faltantes:
```
pnpm license:add
```
Verificar encabezados de licencia faltantes:
```
pnpm license:check
```

Enviando Contribuciones

Reportar Problemas

Si encuentras un error o tienes una solicitud de característica, por favor abre un issue en GitHub. Proporciona tanto detalle como sea posible, incluyendo:

Un título claro y descriptivo.
Pasos para reproducir el error (si aplica).
Comportamiento esperado y comportamiento real.
Capturas de pantalla o fragmentos de código (si es útil).
Detalles de tu entorno (SO, versión de Node, versión de pnpm).

Pull Requests (PRs)

¡Nos encantan los pull requests! Aquí hay una guía rápida:

Crear una rama: Comienza desde la rama main y crea un nombre de rama descriptivo (ej., fix/login-bug, feat/new-template-option).
```
git checkout main
git pull origin main
git checkout -b your-branch-name
```
Hacer tus cambios: Escribe tu código o mejoras en la documentación.
Probar tus cambios: Asegúrate de que todas las pruebas pasen:
```
pnpm test
```
Verificar calidad de código: Asegúrate de que las verificaciones de formato y linting pasen:
```
pnpm check
```
Hacer commit de tus cambios: Usamos Conventional Commits para mensajes de commit, reforzado por commitlint. Esto ayuda a automatizar changelogs y versionado. Un mensaje de commit típico se ve como feat: add new command o fix: resolve issue with parsing. Puedes usar pnpm commitlint para ayudar a formatear tu mensaje si es necesario, o usar herramientas como git cz si lo tienes instalado.
```
git add .
git commit -m "feat: your descriptive commit message"
```
Push de tu rama:
```
git push origin your-branch-name
```
Abrir un Pull Request: Ve al repositorio de YAMLResume en GitHub y haz clic en el botón "New pull request". Compara tu rama con la rama main.
Describir tu PR: Proporciona una descripción clara de los cambios que has hecho. Enlaza cualquier issue relevante (ej., "Closes #123").
Revisión: Un mantenedor revisará tu PR. Atiende cualquier retroalimentación o cambios solicitados.
Merge: Una vez aprobado, tu PR será fusionado. ¡Gracias por tu contribución!

Licencia

Al contribuir a YAMLResume, aceptas que tus contribuciones serán licenciadas bajo su Licencia MIT.

CLI

Docker

Test

Nuevo Idioma

On this page