Reglas recomendadas

Informar un problema Ver 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. Hacemos 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 mediante la presentación de un problema de GitHub.

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

Requisitos para los encargados de mantener reglas

  • El conjunto de reglas proporciona una función importante, ú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 es 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 prueba.
  • El conjunto de reglas se prueba en BuildKite con la versión más reciente de Bazel. Las pruebas siempre deben ser exitosas (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 roturas deben arreglarse 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 frecuentemente con Bazel de manera directa (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 ocurre, el cambio debe corregirse o revertirse.

Descenso de nivel

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

Se comunicará con los encargados de mantener las reglas, quienes deberán responder en 2 semanas. Según el resultado, el equipo principal de Bazel podría tomar la decisión de descender de nivel el conjunto de reglas.