Reglas recomendadas

Informa un problema Ver código fuente

En la documentación, proporcionamos una lista de reglas recomendadas.

Este es un conjunto de reglas de alta calidad, que proporcionarán una buena experiencia a nuestros usuarios. Diferenciamos las reglas compatibles y las cientos de reglas que puedes encontrar en Internet.

Nominación

Si un conjunto de reglas cumple con los requisitos que se indican a continuación, un encargado de mantenimiento puede nominarlo para que forme parte de las reglas recomendadas mediante la presentación de un problema de GitHub.

Después de una revisión del equipo principal de Bazel, se recomienda hacerlo en el sitio web de Bazel.

Requisitos para los encargados de mantener las normas

  • El conjunto de reglas proporciona una función importante que resulta útil para una gran cantidad de usuarios de Bazel (por ejemplo, compatibilidad con un lenguaje ampliamente popular).
  • El conjunto de reglas está bien mantenido. Debe haber al menos dos encargados de mantenimiento activos.
  • El conjunto de reglas está bien documentado, con ejemplos y es fácil de usar.
  • El conjunto de reglas sigue las prácticas recomendadas y el rendimiento (consulta la guía de rendimiento).
  • El conjunto de reglas tiene suficiente cobertura de prueba.
  • El conjunto de reglas se prueba en BuildKite con la versión más reciente de Bazel. Las pruebas siempre deben aprobarse (cuando se usan como una verificación de envío previo).
  • El conjunto de reglas también se prueba con los próximos cambios incompatibles. Las fallas deberían solucionarse en un plazo de dos semanas. Los problemas de migración deben informarse al equipo de Bazel con rapidez.

Requisitos para desarrolladores de Bazel

  • Las reglas recomendadas se prueban con Bazel a la cabeza con frecuencia (al menos una vez al día).
  • Ningún cambio en Bazel podría romper una regla recomendada (con el conjunto predeterminado de marcas). Si sucede, el cambio debe corregirse o revertirse.

Degradación

Si te preocupa que un conjunto de reglas en particular ya no cumpla con los requisitos, se debe presentar un problema en GitHub.

Nos comunicaremos con los encargados del mantenimiento de reglas, quienes deberán responder en 2 semanas. En función del resultado, el equipo principal de Bazel podría tomar la decisión de descender de nivel el conjunto de reglas.