Lista de comprobación de revisión de pr de vcpkg
Revisión: 1
Información general
En este documento se proporciona una lista de comprobación anotada que usan los miembros del equipo de vcpkg para aplicar la etiqueta "revisada" en las solicitudes de incorporación de cambios entrantes. Si una solicitud de incorporación de cambios infringe cualquiera de estos puntos, podemos pedir a los colaboradores que realicen cambios necesarios antes de poder combinar el conjunto de cambios.
No dude en crear un problema o una solicitud de incorporación de cambios si cree que esta lista de comprobación se puede mejorar. Incremente el número de revisión al modificar el contenido de la lista de comprobación.
Lista de comprobación
Puede vincular cualquiera de estos elementos de lista de comprobación en un comentario de GitHub copiando la dirección de vínculo adjunta a cada código de elemento.
c000001: No se usan funciones auxiliares en desuso
Consulte nuestras Directrices y directivas del mantenedor para obtener más información.
c000002: se actualiza el campo ""port-version""
Consulte nuestras Directrices y directivas del mantenedor para obtener más información.
c000003: los nuevos puertos contienen un campo '"description"' escrito en inglés
Una descripción solo una o algunas oraciones largas es útil. Considere la posibilidad de usar la descripción oficial de la biblioteca de su README.md o similar si es posible. Las traducciones automáticas son aceptables y estamos encantados de limpiar las traducciones al inglés para nuestros colaboradores.
Consulte la documentación del archivo de manifiesto para obtener más información.
c000004: No hay comentarios innecesarios presentes en el conjunto de cambios
Consulte nuestras Directrices y directivas del mantenedor para obtener más información.
c000005: los archivos descargados tienen versiones si están disponibles
Para asegurarse de que el contenido del archivo no cambia, los archivos descargados preferiblemente tienen una etiqueta de versión asociada que se puede incrementar junto con el puerto"version".
c000006: los nuevos puertos pasan comprobaciones de CI para los tripletos que la biblioteca admite oficialmente.
Para garantizar que los puertos vcpkg sean de alta calidad, pedimos que los puertos entrantes admitan las plataformas oficiales para la biblioteca en cuestión.
c000007: las revisiones corrigen problemas que solo son específicos de vcpkg.
Si es posible, las revisiones al código fuente de la biblioteca deben estar ascendentes al repositorio oficial de la biblioteca. Abrir una solicitud de incorporación de cambios en el repositorio de la biblioteca le ayudará a mejorar la biblioteca para todos, no solo para los usuarios de vcpkg.
c000008: los nuevos puertos descargan el código fuente del origen oficial si están disponibles
Para respetar a los autores de bibliotecas y mantener el código seguro, haga que los puertos descarguen el código fuente del origen oficial. Podemos hacer excepciones si el código fuente original no está disponible y existe un interés importante en la comunidad en el mantenimiento de la biblioteca en cuestión.
c000009: los puertos y las características de puerto se denominan correctamente
Para la accesibilidad del usuario, preferimos que los nombres de los puertos y las características de puerto sean intuitivos y cercanos a sus homólogos en orígenes oficiales y otros administradores de paquetes. Si no está seguro acerca de la nomenclatura de un puerto o una característica de puerto, se recomienda comprobar repology.org, packages.ubuntu.com o buscar información adicional mediante un motor de búsqueda. También podemos ayudar a nuestros colaboradores con esto, así que no dude en pedir sugerencias de nomenclatura si no está seguro.
c000010: los destinos de biblioteca se exportan cuando corresponda.
Para proporcionar a los usuarios una integración sin problemas del sistema de compilación, asegúrese de exportar y proporcionar un medio para encontrar los destinos de biblioteca destinados a usarse de bajada. Los destinos que no están diseñados para exportarse deben marcarse como privados y no exportarse.
c000011: Los puertos no usan aplicaciones que modifican el sistema del usuario
Los puertos deben mantener el contrato de vcpkg de no modificar el sistema del usuario evitando las aplicaciones que lo hacen. Algunos ejemplos de estas aplicaciones son sudo, apt, brewo pip. Use una alternativa a estos tipos de programas siempre que sea posible.
c000012: Los puertos con dependencias del sistema incluyen un mensaje de información durante la instalación
Algunos puertos tienen dependencias de herramientas y bibliotecas que no existen en vcpkg. Para estas dependencias que faltan, le pedimos que los colaboradores agreguen un mensaje a la parte superior del puerto portfile.cmake que indica las dependencias que faltan y cómo adquirirlas. Pedimos que el mensaje se muestre antes de que se realice cualquier trabajo importante para asegurarse de que los usuarios puedan "salir temprano" del proceso de instalación lo antes posible en caso de que falten la dependencia.
Ejemplo:
message(
"${PORT} currently requires the following libraries from the system package manager:
autoconf libtool
These can be installed on Ubuntu systems via sudo apt install autoconf libtool"
)
c000013: los archivos de manifiesto se usan en lugar de los archivos CONTROL para los nuevos puertos
Muchos puertos existentes usan la sintaxis del archivo CONTROL; aunque esta sintaxis se admitirá durante algún tiempo, los nuevos puertos no deben usarlos. Cualquier puerto recién agregado debe usar los archivos de manifiesto.
También se recomienda, cuando se realicen modificaciones significativas en los puertos, que uno cambie a los archivos de manifiesto; sin embargo, esto no es necesario. Es posible que le vcpkg format-manifest resulte útil.
