Skip to content

Latest commit

 

History

History
70 lines (56 loc) · 3.29 KB

CONTRIBUTING.md

File metadata and controls

70 lines (56 loc) · 3.29 KB

Contributing to NovelJs

¡Gracias por interesarte en contribuir a NovelJs! Este documento explica cómo puedes colaborar y cómo seguimos un flujo organizado para asegurar la calidad del proyecto.

¿Cómo contribuir?

1. Reportar errores (Bugs)

Si encuentras un error o problema, por favor sigue estos pasos:

  1. Verifica que no exista un reporte previo: Revisa los issues abiertos en el repositorio para asegurarte de que no se haya reportado el mismo error.
  2. Crea un nuevo reporte de error:
    • Ve a la pestaña de Issues.
    • Selecciona la plantilla "Bug Report".
    • Llena los campos según se especifica, proporcionando la siguiente información:
      • Sistema operativo donde ocurrió el error.
      • Comportamiento esperado.
      • Pasos para reproducir el error.
      • Cualquier contexto adicional relevante.
    • Asegúrate de aceptar la declaración de conformidad con las guías del proyecto antes de enviar el reporte.

2. Solicitudes de características (Feature Requests)

Si tienes una idea para mejorar NovelJs, por favor sigue estos pasos:

  1. Revisa los issues existentes para confirmar que no se haya solicitado la misma característica.
  2. Crea un nuevo issue usando una plantilla personalizada (o en blanco si corresponde). Proporciona:
    • Una descripción detallada de la característica que propones.
    • Un ejemplo del caso de uso o problema que solucionaría.
    • Cualquier detalle técnico que consideres importante.

3. Contribuir con código

Si deseas contribuir con código, sigue estos pasos:

  1. Elige un issue:
    • Busca un issue etiquetado como good first issue o help wanted.
    • Comenta en el issue para indicar que estás trabajando en él.
  2. Clona el repositorio: 
    git clone https://github.com/tu-usuario/noveljs.git
  3. Crea una rama de trabajo: 
    git checkout -b fix/mi-arreglo
  4. Asegúrate de seguir el estilo del proyecto:
    • Usa comentarios claros en tu código.
    • Mantén las dependencias externas al mínimo.
  5. Envía un Pull Request (PR):
    • Proporciona una descripción clara de los cambios realizados.
    • Relaciona el PR con el issue correspondiente.
    • Sigue el proceso de revisión de código antes de la integración.

4. Otros tipos de contribución

Si quieres contribuir de otras maneras (documentación, pruebas, etc.), siéntete libre de abrir un issue para coordinar tu colaboración.

Normas de la comunidad

Por favor, revisa nuestro Código de Conducta para asegurarte de mantener un ambiente respetuoso y colaborativo.

Contacto

Si tienes preguntas o necesitas ayuda, puedes contactar al mantenedor del proyecto:

Elementos destacados:

  1. Alineación con tu plantilla de Bug Report: Se mencionan los pasos y los campos requeridos (Sistema Operativo, Pasos, Contexto Adicional, etc.).
  2. Estructura clara: Se incluyen secciones para bugs, nuevas características, contribuciones de código y contribuciones alternativas.
  3. Contacto: Se incluye la información de contacto como lo mencionaste en el contact_links.

Si necesitas ajustes o algo más específico, ¡avísame! 😊