Reglas recomendadas

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

Este es un conjunto de reglas de alta calidad que brindarán una buena experiencia a nuestros usuarios. Establecemos una distinción entre las reglas admitidas y los cientos de reglas que puedes encontrar en Internet.

Nominación

Si un conjunto de reglas cumple con los siguientes requisitos, un encargado de mantenimiento de reglas puede nominarlo para que forme parte de las reglas recomendadas. Para ello, debe presentar un problema de GitHub.

Después de la revisión del equipo principal de Bazel, se recomendará en el sitio web de Bazel.

Requisitos para los encargados del mantenimiento de reglas

  • El conjunto de reglas proporciona una función importante que es útil para una gran cantidad de usuarios de Bazel (por ejemplo, compatibilidad con un lenguaje muy popular).
  • El conjunto de reglas se mantiene en buen estado. Debe haber al menos dos encargados de mantenimiento activos.
  • El conjunto de reglas está bien documentado, con ejemplos y fácil de usar.
  • El conjunto de reglas sigue las prácticas recomendadas y tiene un buen rendimiento (consulta la guía de rendimiento).
  • El conjunto de reglas tiene suficiente cobertura de pruebas.
  • 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 verificación previa al envío).
  • El conjunto de reglas también se prueba con los próximos cambios incompatibles. Las fallas deben corregirse en un plazo de dos semanas. Los problemas de migración deben informarse rápidamente al equipo de Bazel.

Requisitos para desarrolladores de Bazel

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

Descensos de nivel

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

Nos comunicaremos con los encargados de mantener reglas y responderemos en un plazo de 2 semanas. En función del resultado, el equipo principal de Bazel puede tomar la decisión de descender de nivel el conjunto de reglas.