horchatajs / website Goto Github PK

Mejorar instrucciones para desarrollo local en README.

• Instalación global de Gatsby
• Crear archivo .env y colocar API_KEY de Meetup
• Entre otras.

Descripción de la idea/sugerencia
Como proyecto comunitario de debería tener una guía de estilos que permita mantener la consistencia de las contribuciones que se vayan aceptado.

Entiendo que incluir este tipo de sugerencia podría cambiar parte del código ya existente. Lo anterior no creo que sea problema en la medida que beneficie a futuro las nuevas contribuciones.

Seria interesante evaluar ejemplos de otros proyectos que sigan una guía de estilo o posibles mejores prácticas.

• Registro
• Participar
• Redes sociales
• Código de conducta
• Patrocinar
• Slack

Descripción del error
Usando la herramienta webhint.io aparecen varios errores de accesibilidad, rendimiento y seguridad que se pueden resolver.

Comportamiento esperado
No recibir ningún error (o la menor cantidad posible) usando la herramienta de webhint.

Pasos para reproducir el error
Visitar el reporte (o volver a realizarlo) aquí: https://webhint.io/scanner/9330eecb-07c7-4643-9ff9-4a28e84dedbc

¿La sugerencia está relacionada con un problemas? Por favor describilo.
Quiero conocer de manera rápida el número de miembros registrados en la comunidad.

Descrí la solución que te gustaría ver
Ver el número de miembros en Meetup de la comunidad HorchataJS en el botón de registro.

• Etiquetas para SEO
• Etiquetas para Facebook
• Etiquetas para Twitter

Más información: https://github.com/joshbuchea/HEAD#social

• Mejorar archivo README.md
• Agregar comentarios básicos en archivos de configuraciones
• Crear plantilla para reportes de errores
• Crear plantilla para pull request
• Agregar archivo CONTRIBUTING.md

Descripción del error
El menú en dispositivos móviles queda activado al navegar entre páginas del sitio.

Comportamiento esperado
Al probar el sitio móvil, el menú debe volver a su estado original (escondido) cada vez que el usuario cambie de página.

Pasos para reproducir el error

1. Visitar el sitio en un móvil (o probar desde herramienta de desarrollo móvil).
2. Hacer click en el menú.
3. Hacer click en 'Blog'

Detalles de entorno
https://mybrowser.fyi/report/5b7512476e6d49001430a833

Información adicional
Tal vez se puede considerar usar alguna librería para menús móviles ya disponble.

Descripción del error
El color de fondo del menú en móviles es transparente y hace difícil distinguir el contenido. Esto podría generar más problemas cada vez que las opciones del menú vayan incrementando.

Comportamiento esperado
El contenido del menú en móviles debería ser fácil de leer y diferenciar del fondo del sitio.

Pasos para reproducir el error
Pasos para reproducir el comportamiento:

1. Ver-emular cualquier página del sitio en tamaño móvil.
2. Hacer click en el botón de hamburguesa.
3. Ver opciones del menú.

Detalles de entorno
http://mybrowser.fyi/report/5bc11b9c25d6dc00140a230c

Problema

En el archivo README.md no esta la referencia directa hacia el archivo CONTRIBUTING.md

Detalles del entorno

• README.md

Pasos para replicar

No Aplica

Comportamiento esperado

No Aplica

Comportamiento actual

No Aplica

Agregar plantilla a utilizar para el correcto reporte de errores.

Leer: https://github.com/devspace/awesome-github-templates

Descripción del error
Algunos textos del sitio son difíciles de leer en dispositivos móviles. Específicamente los títulos principales como el de la página de inicio.

Comportamiento esperado
Lo textos deberían ser proporcionales al tamaño del dispositivo.

Leer: https://github.com/devspace/awesome-github-templates

Más información: https://github.com/joshbuchea/HEAD#icons

Descripción del error
La información de las etiquetas sociales de los enlaces del blog no están funcionando.

Comportamiento esperado
Al compartir un enlace del blog, el titulo, descripción e imagen deben ser sobre el contenido de la publicación correspondiente.

Comportamiento actual
Al compartir un enlace del blog la información siempre es del sitio en general.

Pasos para reproducir el error

1. Copiar un enlace cualquiera del blog.
2. Compartir el enlace en Facebook (sin publicar).
3. Esperar a que cargue la vista previa.

Información adicional
Se puede probar el comportamiento directamente en este enlace: https://developers.facebook.com/tools/debug/sharing/?q=https%3A%2F%2Fwww.horchatajs.com%2Fblog%2F2018-09-08-resena-horchatajs-agosto-2018%2F

Problema

La misma plantilla para reportar errores se usa para solicitar nuevas caracteristicas.

Detalles del entorno

No Aplica.

Pasos para replicar

Crear un nuevo isssue.

Comportamiento esperado

Poder elegir la plantilla segun lo que quiero reportar o sugerir..

Comportamiento actual

Solo se puede usar la plantilla de reporte de errores.

Add favicon to site

Compatible with all browser, I suggest using this icon