¿Qué hay en la carpeta "contrib"?

A menudo, los proyectos de software de código abierto tienen una carpeta llamada "contrib". Por ejemplo, Django tiene uno . ¿Para qué sirve?

Es para el software que ha contribuido al proyecto, pero que los desarrolladores principales podrían no mantener. Nombrarlo "contrib" o "Contrib" es una convención establecida desde hace mucho tiempo, pero en realidad no hay nada especial sobre el nombre, y generalmente solo se usa en proyectos bastante grandes.

Mirando los proyectos populares de código abierto que vienen a la mente, no veo ninguna mención de ninguna carpeta "contrib":

• jQuery ,
• Expreso ,
• Sass ,
• MENOS ,
• MongoDB ,
• Redis ,
• Títeres ,
• Cocinero
• NUnit ,
• Ruby on Rails ,
• laravel ,
• Jenkins ,
• Clojure ,
• Rubí .

El único que tiene una carpeta "contrib" es Django. Para Django, el papel de esta carpeta ya se explica en la documentación :

Django tiene como objetivo seguir la filosofía de "baterías incluidas" de Python. Se entrega con una variedad de herramientas adicionales opcionales que resuelven problemas comunes de desarrollo web.

Este código vive django/contriben la distribución de Django. Este documento ofrece un resumen de los paquetes en contrib, junto con cualquier dependencia que tengan esos paquetes.

El Capítulo 16 de The Django Book contiene una descripción más detallada del rol de este directorio y la lista de contenidos.

Otro ejemplo es Solr . Con gitstats, podemos obtener las estadísticas sobre los contribuyentes.

Robert Muir         22.09%
Michael McCandless  13.60%
Mark Robert Miller   9.73%
Uwe Schindler        8.17%
Yonik Seeley         5.56%
Steven Rowe          5.55%

Luego, podemos seleccionar solo el contribdirectorio ejecutando:

git filter-branch --subdirectory-filter solr/contrib --prune-empty

y obtenga las estadísticas una vez más:

Robert Muir         19.62%
Steven Rowe          8.87%
Mark Robert Miller   8.33%
Uwe Schindler        8.06%
James Dyer           7.80%

Por lo tanto, los principales autores son prácticamente los mismos, lo que significa que no son contribuciones de personas externas. Mirando los directorios dentro de la contribcarpeta, parece que una vez más, se trata de "una variedad de herramientas adicionales y opcionales", exactamente como en Django. Por ejemplo, no necesita el controlador de solicitud de importación de datos para que Solr funcione, pero si desea importar datos de una base de datos o XML, es bueno contribtenerlos en la carpeta. Lo mismo para map-reduce, puede que no lo necesite necesariamente, pero hay casos en los que lo necesita.

¿Son esos complementos o complementos? No usaría este término. Los complementos y complementos tienen una integración específica con la aplicación principal. Por ejemplo, no se espera que un complemento se ejecute de forma independiente, sino alojado dentro de la aplicación principal. Por otro lado, contribcontiene herramientas que probablemente pueden ejecutarse de forma independiente.

Está destinado a bibliotecas o componentes que contribuyen al proyecto, pero que no son propiedad ni son parte del proyecto en sí. Siempre lo he usado como una ubicación común o compartida para colocar las bibliotecas de terceros que estoy usando.

Por ejemplo, podrías tener:

• / Contrib / log4net-xxx
• /Contrib/SSH.NET-xxx
• / BackendService
• / DesktopUI
• / GenUtils
• / SMCore
• / WebUI

Luego, haga referencia a ellos en cada uno de los componentes del proyecto utilizando rutas relativas, de modo que no se necesite ningún tipo de configuración o configuración antes de construirlo. Se generará directamente desde el repositorio sin importar dónde se haya extraído localmente.

Git es un gran ejemplo de software de código abierto que utiliza esta convención:

https://github.com/git/git/tree/master/contrib

Aquí hay un extracto relevante de ese archivo README.md:

Software contribuido

Aunque estas piezas están disponibles como parte del árbol fuente oficial de git, están en un estado algo diferente. La intención es mantener herramientas interesantes alrededor de git aquí, tal vez incluso las experimentales, para darles a los usuarios un acceso más fácil a ellas y para que las herramientas tengan una mayor exposición, de modo que puedan mejorarse más rápido.

No espero tocarlos tanto. En lo que respecta a mi operación diaria, estos subdirectorios son propiedad de sus respectivos autores principales. Estoy dispuesto a ayudar si los usuarios de estos componentes y los "propietarios" de contrib / subtree tienen problemas técnicos / de diseño para resolver, pero la iniciativa para arreglar y / o mejorar las cosas debe estar del lado de los propietarios de subtree.