Contribución - PaulAguirre98/Evidencia-productividad GitHub Wiki

Contribuyendo a la transcriptasa

¡Nos encanta tu opinión! Queremos que la contribución a este proyecto sea lo más fácil y transparente posible, ya sea:

  • Informar un error
  • Discutir el estado actual del código
  • Enviar una corrección
  • Proponer nuevas funciones
  • Convertirse en mantenedor

Desarrollamos con Github Usamos github para alojar código, rastrear problemas y solicitudes de funciones, así como aceptar solicitudes de extracción.

Usamos Github Flow, por lo que todos los cambios de código ocurren a través de solicitudes de extracción Las solicitudes de extracción son la mejor manera de proponer cambios en la base de código (usamos Github Flow). Damos la bienvenida activamente a sus solicitudes de extracción:

  • Bifurque el repositorio y cree su rama desde master.
  • Si ha agregado código que debería probarse, agregue pruebas.
  • Si ha cambiado de API, actualice la documentación.
  • Asegúrese de que la suite de pruebas pase.
  • Asegúrese de que su código lints.
  • ¡Emita esa solicitud de extracción!

Cualquier contribución que haga estará bajo la licencia de software del MIT En resumen, cuando envía cambios de código, se entiende que sus envíos están bajo la misma licencia MIT que cubre el proyecto. No dude en ponerse en contacto con los mantenedores si eso le preocupa.

Informar errores usando los problemas de Github Usamos problemas de GitHub para rastrear errores públicos. Informar un error abriendo un nuevo problema; ¡es fácil!

Escriba informes de errores con detalles, antecedentes y código de muestra Este es un ejemplo de un informe de error que escribí y creo que no es un mal modelo. Aquí hay otro ejemplo de Craig Hockenberry, un desarrollador de aplicaciones a quien respeto mucho.

Los grandes informes de errores suelen tener:

  • Un resumen rápido y / o antecedentes
  • Pasos para reproducir
    • ¡Se específico!
    • Proporcione un código de muestra si puede. Mi pregunta de stackoverflow incluye un código de muestra que cualquier persona con una configuración básica de R puede ejecutar para reproducir lo que estaba viendo
  • Lo que esperabas que pasara
  • Que pasa realmente
  • Notas (posiblemente incluyendo por qué cree que esto podría estar sucediendo, o cosas que intentó que no funcionaron)

A la gente le encantan los informes de errores completos. Ni siquiera estoy bromeando.

Use un estilo de codificación consistente Nuevamente los estoy tomando prestados de las Pautas de Facebook

  • 2 espacios para sangría en lugar de pestañas
  • Puede intentar ejecutar npm run lint para la unificación de estilo

Licencia Al contribuir, acepta que sus contribuciones estarán autorizadas bajo su Licencia MIT.

Referencias Este documento fue adaptado de las pautas de contribución de código abierto para el Borrador de Facebook