Giter Club home page Giter Club logo

ayudante-virtual's Introduction

Ayudante virtual

Build Status   Coverage Status

Bot de Slack que sirve como ayudante virtual para realizar consultas que no pueden ser compartidas en canales públicos. Los alumnos realizan las consultas al bot y este las publica en un canal (posiblemente privado), donde estén solo los ayudantes. Ejemplo de consulta:

Consulta del alumno (mensaje directo del alumno al ayudante virtual):

Tengo una consulta

Aviso a los ayudantes en otro canal (posiblemente privado):

Consulta reenviada a los ayudantes

Esto permite que las consultas de los alumnos que no puedan compartirse públicamente con toda la clase queden centralizadas en un único canal, para que luego los ayudantes puedan organizarse y responder a los alumnos por mensaje directo.

De esta manera los ayudantes pueden responder más rápidamente dichas consultas, dado que cualquiera que este disponible pueda verlas y tomarlas. A su vez si hay muchas consultas para responder, al estar todas en el mismo lugar los ayudantes pueden organizarse para balancear el tiempo utilizado en dicha tarea.

Bienvenida

El Ayudante Virtual también envía un mensaje de bienvenida a los nuevos miembros para que sepan cómo utilizarlo:

Bienvenida

Instalación

Para instalar en el espacio de trabajo ir a:

Add to Slack

Configurar canales públicos

Luego es necesario ejecutar el comando /set-canal-de-consultas #mi-canal-de-consultas para que el bot envíe las consultas a #mi-canal-de-consultas. A su vez el bot debe ser miembro de dicho canal.

Configurar canales privados

Si se desea recibir las consultas en un canal privado, se debe agregar al bot al mismo y luego ejecutar el comando /set-canal-de-consultas aquí en el canal donde se deseen recibir las consultas.

Advertencia

Durante la instalación es posible que observes un mensaje de Slack diciendo que "Slack no revisó o aprobó esta aplicación". Esto es así porque por el momento no se envío la app para revisión por Slack dado que para ello se necesita un dominio, un sitio web, ofrecer la posibilidad de dar soporte fuera de GitHub y otros detalles. Sin embargo este bot es de código abierto y se ofrece la posibilidad de ver y mejorar el mismo a través de pull requests.

Uso

Los alumnos simplemente deben hablar con el bot para enviarles sus consultas. Cuando un nuevo usuario se une al espacio de trabajo el bot lo saluda explicándole como usarlo. A su vez con las palabras clave 'hola', 'ayuda', 'hi', etc. se muestran mensajes de ayuda al alumno.

Ayuda

Finalmente para enviar la consulta se debe anteponer la frase 'Tengo una consulta', y dicha consulta se enviará al canal configurado previamente.

Consulta con adjuntos

La cual se notifica a los ayudantes en el canal configurado:

Consulta con adjuntos reenviada a los ayudantes

Cómo se ve previamente los alumnos pueden incluir links, texto en formato de código y adjuntos.

Por otro lado, si el alumno envía algo no entendido por el Ayudante Virtual, se envía una respuesta notificándolo:

Mensaje no entendido

Reporte de problemas

Por favor reportar cualquier problema encontrado en la sección de problemas.

Privacidad

El Ayudante Virtual no guarda ni envía ningún tipo de información sobre los mensajes o miembros de los espacios de trabajo fuera de Slack. Lo único que es necesario guardar son los ids de los canales configurados para recibir las consultas. Dicha información no es divulgada con ninguna entidad.

Contribuir

Se acepta la colaboración a través de reportes en la sección de problemas o pull requests. En caso de querer desarrollar, luego de clonar el repositorio los comandos disponibles son los siguientes (Node.js requerido):

  • npm install

    Instala las dependencias del projecto.

  • npm run build

    Compila el projecto en dist.

  • npm start

    Compila e inicia el projecto.

  • npm run dev

    Inicia el proyecto en modo desarrollo, recompilando cada vez que ocurra un cambio.

  • npm test

    Ejecuta los tests.

  • npm run test:watch

    Ejecuta los tests y los vuelve a ejecutar al detectar cambios.

  • npm run coverage

    Luego de ejecutar los tests, se envía el resultado a coveralls. Es necesario que esté configurada la variable de ambiente COVERALLS_REPO_TOKEN.

Licencia

El Ayudante Virtual adhiere a la licencia MIT.

ayudante-virtual's People

Contributors

seblaz avatar

Watchers

James Cloos avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.