Coding Starter Projects

Proyectos de la codificación

¡Un repositorio básico para compartir sus proyectos de inicio con otros y ayudarlos a crecer también!

En primer lugar, ¡gracias por tomarse el tiempo para contribuir!

Todos los tipos de contribuciones son alentados y valorados. Consulte la tabla de contenido para obtener diferentes formas de ayudar y detalles sobre cómo los maneja este proyecto. Asegúrese de leer la sección relevante antes de hacer su contribución. Hará que sea mucho más fácil para los mantenedores y suavizará la experiencia para todos los involucrados. La comunidad espera sus contribuciones.

Y si te gusta el proyecto, pero simplemente no tienes tiempo para contribuir, está bien. Hay otras formas fáciles de apoyar el proyecto y mostrar su agradecimiento, de lo que también estaríamos muy contentos:

• Estrella el proyecto
• Tweet al respecto
• Consulte este proyecto en el ReadMe de su proyecto
• Mencione el proyecto en las reuniones locales y cuénteles a sus amigos/colegas

Tabla de contenido

• Código de conducta
• Tengo una pregunta
• Quiero contribuir
• Informes de informes
• Sugiriendo mejoras

Código de conducta

Este proyecto y todos los que participan en él se rigen por el Código de Conducta de MD. Al participar, se espera que mantenga este código. Informe un comportamiento inaceptable a <>.

Tengo una pregunta

Si desea hacer una pregunta, asumimos que ha leído la documentación disponible.

Antes de hacer una pregunta, es mejor buscar problemas existentes que puedan ayudarlo. En caso de que haya encontrado un problema adecuado y aún necesite una aclaración, puede escribir su pregunta en este tema. También es aconsejable buscar en Internet las respuestas primero.

Si aún siente la necesidad de hacer una pregunta y necesita aclaraciones, recomendamos lo siguiente:

• Abra un problema.
• Proporcione todo el contexto que pueda sobre lo que se encuentra.
• Proporcione versiones de proyecto y plataforma (NodeJS, NPM, etc.), dependiendo de lo que parezca relevante.

Luego nos ocuparemos del problema lo antes posible.

Quiero contribuir

Aviso legal

Al contribuir a este proyecto, debe aceptar que haya escrito el 100% del contenido, que tiene los derechos necesarios al contenido y que el contenido que contribuye puede proporcionar bajo la licencia del proyecto.

Informes de informes

Antes de enviar un informe de error

Un buen informe de errores no debería dejar que otros necesiten perseguirlo para obtener más información. Por lo tanto, le pedimos que investigue cuidadosamente, recopile información y describa el problema en detalle en su informe. Complete los siguientes pasos por adelantado para ayudarnos a arreglar cualquier error potencial lo más rápido posible.

• Asegúrese de estar utilizando la última versión.
• Determine si su error es realmente un error y no un error de su lado, por ejemplo, utilizando componentes/versiones de entorno incompatibles (asegúrese de haber leído la documentación. Si está buscando soporte, es posible que desee verificar esta sección).
• Para ver si otros usuarios han experimentado (y potencialmente ya han resuelto) el mismo problema que está teniendo, verifique si aún no existe un informe de error para su error o error en el rastreador de errores.
• También asegúrese de buscar en Internet (incluido el desbordamiento de pila) para ver si los usuarios fuera de la comunidad de GitHub han discutido el problema.
• Recopile información sobre el error:
• Stack Trace (traza)
• Sistema operativo, plataforma y versión (Windows, Linux, macOS, x86, brazo)
• Versión del intérprete, compilador, SDK, entorno de tiempo de ejecución, administrador de paquetes, dependiendo de lo que parezca relevante.
• Posiblemente su entrada y la salida
• ¿Puedes reproducir de manera confiable el problema? ¿Y también puedes reproducirlo con versiones más antiguas?

¿Cómo envío un buen informe de errores?

Nunca debe informar problemas, vulnerabilidades o errores relacionados con la seguridad, incluida la información confidencial al rastreador de problemas, o en otros lugares del público. En su lugar, los errores confidenciales deben enviarse por correo electrónico a <>.

Utilizamos problemas de GitHub para rastrear errores y errores. Si te encuentras con un problema con el proyecto:

• Abra un problema. (Dado que no podemos estar seguros en este punto si es un error o no, le pedimos que no hable sobre un error y que no etiquete el problema).
• Explique el comportamiento que esperaría y el comportamiento real.
• Proporcione el mayor contexto posible y describa los pasos de reproducción que alguien más puede seguir para recrear el problema por su cuenta. Esto generalmente incluye su código. Para obtener buenos informes de errores, debe aislar el problema y crear un caso de prueba reducido.
• Proporcione la información que recopiló en la sección anterior.

Una vez que se presenta:

• El equipo del proyecto etiquetará el problema en consecuencia.
• Un miembro del equipo intentará reproducir el problema con sus pasos proporcionados. Si no hay pasos de reproducción o ninguna forma obvia de reproducir el problema, el equipo le solicitará esos pasos y marcará el problema como needs-repro . Los errores con la etiqueta needs-repro no se abordarán hasta que se reproduzcan.
• Si el equipo puede reproducir el problema, será marcado de needs-fix , así como posiblemente otras etiquetas (como critical ), y el problema será implementado por alguien.

Sugiriendo mejoras

Esta sección lo guía a través de una sugerencia de mejora para contribuir. MD, incluidas características completamente nuevas y mejoras menores en la funcionalidad existente . Seguir estas pautas ayudará a los mantenedores y a la comunidad a comprender su sugerencia y encontrar sugerencias relacionadas.

Antes de enviar una mejora

• Asegúrese de estar utilizando la última versión.
• Lea la documentación cuidadosamente y descubra si la funcionalidad ya está cubierta, tal vez por una configuración individual.
• Realice una búsqueda para ver si la mejora ya se ha sugerido. Si es así, agregue un comentario al problema existente en lugar de abrir uno nuevo.
• Descubra si su idea se ajusta al alcance y los objetivos del proyecto. Depende de usted presentar un caso fuerte para convencer a los desarrolladores del proyecto de los méritos de esta característica. Tenga en cuenta que queremos características que sean útiles para la mayoría de nuestros usuarios y no solo un pequeño subconjunto. Si solo se dirige a una minoría de usuarios, considere escribir una biblioteca de complementos/complementos.

¿Cómo presento una buena sugerencia de mejora?

Las sugerencias de mejora se rastrean como problemas de GitHub.

• Use un título claro y descriptivo para el problema para identificar la sugerencia.
• Proporcione una descripción paso a paso de la mejora sugerida en tantos detalles como sea posible.
• Describa el comportamiento actual y explique qué comportamiento esperaba ver en su lugar y por qué. En este punto, también puede saber qué alternativas no funcionan para usted.
• Es posible que desee incluir capturas de pantalla y GIF animados que lo ayuden a demostrar los pasos o señalar la parte con la que está relacionada la sugerencia. Puede usar esta herramienta para grabar GIF en macOS y Windows, y esta herramienta o esta herramienta en Linux.
• Explique por qué esta mejora sería útil para la mayoría de los usuarios de MD. También es posible que desee señalar los otros proyectos que lo resuelven mejor y que podrían servir como inspiración.