heydeer

Preguntas frecuentes

Todo lo que preguntan los equipos antes y después de empezar: configuración, revisiones, correcciones, precios y seguridad.

Primeros pasos

¿Cómo configuro HeyDeer?

Conecta GitHub, elige los repositorios y pide una revisión:

  • Inicia sesión con GitHub y elige tu cuenta personal u organización en Elige dónde están tus repositorios. Si no aparece, selecciona Instalar en GitHub y elígela allí.
  • En GitHub, elige Only select repositories, marca los que quieres revisar y confirma. En una organización, GitHub pide la aprobación de un propietario, salvo que lo seas tú.
  • Decide si HeyDeer revisa por su cuenta: deja Revisar pull requests automáticamente activado para revisar cada push, hasta 5 veces por pull request, o desactívalo para revisar solo cuando alguien lo pida.
  • Comenta @heydeer review en un pull request abierto.

Necesitas acceso de escritura al repositorio. Un espacio de trabajo nuevo empieza en el plan gratuito, sin tarjeta de crédito, y los hallazgos llegan como comentarios de revisión en el pull request.

Más información: Inicio rápido
¿HeyDeer funciona con GitLab o Bitbucket?
HeyDeer funciona con GitHub, en repositorios públicos y privados, para organizaciones y cuentas personales. Se instala como GitHub App y tú eliges qué repositorios puede leer y revisar, así que su acceso se limita al código que quieres revisar. Cada espacio de trabajo pertenece a una cuenta de GitHub; para conectar otra, selecciona Añadir espacio de trabajo en el menú del espacio de trabajo.
Más información: GitHub App y permisos
¿Tengo que configurar algo antes de la primera revisión?

Puedes pedir una revisión justo después de conectar. HeyDeer lee los cambios del pull request en el contexto de todo el repositorio, junto con el título, la descripción y la discusión del PR, y cada revisión ya busca bugs y problemas de seguridad.

Cuando tus primeras revisiones muestren una carencia, añade pautas donde corresponda:

  • AGENTS.md para cómo funciona tu código y las convenciones que sigue; los agentes de programación también lo siguen.
  • REVIEW.md para lo que las revisiones deben buscar, lo que deben dejar de lado y la gravedad de cada problema.
  • Una comprobación del repositorio para un requisito que HeyDeer debe verificar en cada pull request que cambie ciertos archivos.
  • Instrucciones de revisión para pautas que un pull request no debe poder cambiar o que se aplican a todos los repositorios.
Más información: Qué lee HeyDeer
¿Cuándo empieza HeyDeer a revisar pull requests?

En cuanto alguien lo pide: comenta @heydeer review en un pull request, selecciona Iniciar revisión en la página Historial de revisiones o selecciona Re-run en la comprobación HeyDeer Review. Un espacio de trabajo nuevo empieza en Solo manual, y justo después de la configuración HeyDeer pregunta si debe revisar automáticamente.

Un administrador del espacio de trabajo puede cambiar la frecuencia cuando quiera en Configuración del espacio de trabajo → Reglas de revisión → Cuándo revisar:

  • Una vez por PR revisa un pull request que cumpla los filtros hasta que una revisión termine correctamente.
  • En cada push revisa cuando el pull request cumple tus filtros por primera vez y después de cada push que añada commits, hasta 5 veces por defecto.

Por defecto, las revisiones automáticas omiten borradores, forks y actualizaciones de dependencias.

Más información: Revisiones automáticas
¿Por qué HeyDeer dice que está esperando la aprobación de un propietario de GitHub?
En una organización de GitHub, solo un propietario puede instalar la GitHub App de HeyDeer, así que cuando la conecta otra persona, GitHub envía una solicitud a los propietarios y HeyDeer muestra Esperando la aprobación de un propietario de GitHub. Los administradores del espacio de trabajo pueden aprovechar la espera para ajustar la configuración, de modo que las revisiones funcionen como quieres desde el principio. En cuanto un propietario la aprueba en GitHub, el espacio de trabajo se conecta solo y HeyDeer envía un correo a la dirección de notificaciones del espacio de trabajo.
Más información: GitHub App y permisos
¿Cómo añado más repositorios?
Selecciona Añadir repositorios en la página Repositorios, o Gestionar acceso a GitHub en Configuración del espacio de trabajo → Conexión con GitHub, y elige los repositorios en GitHub. Solo un propietario de la cuenta de GitHub puede guardar el cambio; los demás ven Pedir ayuda al equipo, con una solicitud que pueden copiar y enviar a un propietario. Los repositorios añadidos siguen los valores predeterminados del espacio de trabajo en Reglas de revisión, así que se revisan como el resto desde el primer momento. Para incluir también los repositorios que se creen más adelante, elige Todos los repositorios en GitHub.
Más información: GitHub App y permisos
¿Cómo implantamos HeyDeer en el equipo?

Introdúcelo por etapas y deja que HeyDeer controle los merges cuando tu equipo confíe en sus resultados:

  • Pruébalo en unos pocos pull requests: con las revisiones automáticas desactivadas, comenta @heydeer review en un puñado de pull requests de distinto tipo y compara los hallazgos con los de tus revisores.
  • Cubre las carencias que muestren esas revisiones: convenciones en AGENTS.md, requisitos en comprobaciones del repositorio y prioridades en instrucciones de revisión.
  • Activa las revisiones automáticas en uno o dos repositorios (selecciónalos en Repositorios y luego Cambiar frecuencia) y después en todo el espacio de trabajo.
  • Haz obligatoria la comprobación HeyDeer Review, decide sobre la aprobación automática y, en un plan de pago, configura la recarga automática y un límite de uso.

Pasa a la siguiente etapa cuando tu equipo actúe sobre la mayoría de los hallazgos y las revisiones terminen sin notas de la revisión. Los administradores del espacio de trabajo cambian la configuración; cualquiera con acceso de escritura puede pedir revisiones.

Más información: Implantación en tu equipo
¿Puedo probar HeyDeer antes de que lo vea mi equipo?
Sí. En Configuración del espacio de trabajo → Reglas de revisión → Publicar resultados, desactiva Publicar comprobación de GitHub y Publicar comentarios de revisión en el PR. Después pide revisiones con Iniciar revisión en la página Historial de revisiones y lee allí los resultados; solo aparecen en HeyDeer. Las revisiones se siguen ejecutando y usan créditos. Vuelve a activar ambas opciones cuando quieras compartir las revisiones con tu equipo.
Más información: Publicar resultados
¿Cómo sé que HeyDeer recibió mi solicitud?
HeyDeer añade 👀 a tu comentario cuando acepta la solicitud, lo quita cuando termina la revisión y publica la revisión en el pull request. Mientras tanto, la comprobación HeyDeer Review muestra el progreso de la revisión. Si HeyDeer no puede ejecutar la revisión, o esta falla o se cancela, HeyDeer responde a tu comentario. Un comentario que no recibe 👀 no se leyó como comando: publícalo como texto normal en un comentario nuevo, no dentro de código, una cita o una edición.
Más información: Comandos en comentarios de PR
¿Dónde encuentro los resultados de la revisión?
En el pull request. HeyDeer publica sus hallazgos como una revisión de GitHub, con un comentario en línea en las líneas a las que se refiere cada hallazgo; un hallazgo sobre código fuera del diff, como una llamada sin cambios que el cambio rompe, aparece en Hallazgos adicionales en el cuerpo de la revisión. La comprobación HeyDeer Review informa del resultado, y su enlace Detalles abre el informe completo en HeyDeer, donde la página Historial de revisiones muestra todas las revisiones. El botón Recorrido abre una guía del cambio que agrupa las ediciones relacionadas y destaca las importantes, para quien lea el pull request después.
Más información: Cómo leer una revisión
¿HeyDeer revisa los pull requests que abren los agentes de programación?
Sí. Los pull requests de agentes de programación y otros bots se revisan como cualquier otro. HeyDeer revisa cada uno de forma independiente del agente que lo escribió, algo importante porque un agente tiende a pasar por alto sus propios errores, y en los pushes posteriores vuelve a comprobar los problemas que señaló antes. Los filtros de revisión automática predeterminados solo omiten los borradores, los forks y las actualizaciones de dependencias de bots como Dependabot y Renovate. Para hacer merge de los pull requests de agentes en cuanto HeyDeer los apruebe, sigue la configuración para equipos sin revisión de código.
Más información: Equipos sin revisión de código

¿Necesitas más ayuda?

Chatea con el equipo que desarrolla HeyDeer o escríbenos un correo.