Contribuir

¿Encontraste un bug o tienes una idea? Este proyecto es open source y las contribuciones son bienvenidas.

Repositorio

Todo el código está en github.com/ingyesid24/components-comentarios

Clonar e instalar

bash
git clone https://github.com/ingyesid24/components-comentarios.git
cd components-comentarios
npm install

Comandos útiles

bash
npm run build    # Compila la librería a dist/
npm run test    # Ejecuta los tests
npm run dev     # (librería) Ya no aplica, la librería se publica como bundle

Estructura del proyecto

text
src/
  comment-section.ts    # Componente principal (LitElement)
  comment-section.test.ts  # Tests

docs/                   # Sitio de documentación (Astro)
  src/
    pages/              # Landing, guía, API, ejemplos, contribuir
    components/         # Header, Footer, DemoEmbed, CodeBlock
    layouts/            # BaseLayout

dist/                   # Output de la build
  comment-section.es.js
  comment-section.umd.js

Guía para contribuir

  1. 1. Haz fork del repositorio
  2. 2. Crea una rama: git checkout -b mi-feature
  3. 3. Haz tus cambios y corre los tests: npm test
  4. 4. Asegúrate de que la build pase: npm run build
  5. 5. Abre un Pull Request (PR) describiendo los cambios
  6. 6. Espera la revisión y aprobación del mantenedor — nadie puede mergear sin aprobación

Protección de rama main

La rama main está protegida. No se permite push directo ni merge sin PR aprobado. Todo cambio pasa por una Pull Request revisada por el mantenedor del proyecto.

Esto garantiza que cualquier contribución sea revisada línea por línea antes de integrarse, protegiendo el código de modificaciones no autorizadas o maliciosas.

Reportar bugs

Si encuentras un bug, abre un issue aquí con:

  • • Versión del componente
  • • Navegador donde ocurre
  • • Pasos para reproducir
  • • Comportamiento esperado vs actual

Licencia

MIT — puedes usarlo, modificarlo y distribuirlo libremente.