O que há na pasta "contrib"?

Geralmente, os projetos de software de código aberto têm uma pasta chamada "contrib". Por exemplo, o Django tem um . Para que serve?

É para software que foi contribuído para o projeto, mas que pode não ser realmente mantido pelos desenvolvedores principais. Nomear "contrib" ou "Contrib" é uma convenção estabelecida há muito tempo, mas não há realmente nada de especial no nome, e geralmente é usado apenas em projetos razoavelmente grandes.

Olhando para projetos populares de código aberto que vêm à mente, não vejo menção de nenhuma pasta "contrib":

• jQuery ,
• Express ,
• Sass ,
• MENOS ,
• MongoDB ,
• Redis ,
• Fantoche ,
• Chefe de cozinha
• NUnit ,
• Ruby on Rails ,
• Laravel ,
• Jenkins ,
• Clojure ,
• Ruby .

O único que possui uma pasta "contrib" é o Django. Para o Django, o papel desta pasta já está explicado na documentação :

O Django tem como objetivo seguir a filosofia de "baterias incluídas" do Python. É fornecido com uma variedade de ferramentas extras opcionais que resolvem problemas comuns de desenvolvimento da Web.

Este código reside na django/contribdistribuição do Django. Este documento fornece um resumo dos pacotes no contrib, juntamente com quaisquer dependências desses pacotes.

O Capítulo 16 do Livro do Django contém uma descrição mais detalhada do papel deste diretório e da lista de conteúdos.

Outro exemplo é o Solr . Com gitstats, podemos obter as estatísticas sobre os colaboradores.

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%

Em seguida, podemos selecionar apenas o contribdiretório executando:

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

e obtenha as estatísticas mais uma vez:

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

Portanto, os principais autores são praticamente os mesmos, o que significa que essas não são contribuições de pessoas de fora. Olhando para os diretórios dentro da contribpasta, parece que mais uma vez, essas são “uma variedade de ferramentas opcionais extras”, exatamente como no Django. Por exemplo, você não precisa do manipulador de solicitação de importação de dados para fazer o Solr funcionar, mas se você deseja importar dados do banco de dados ou XML, é bom tê-lo na contribpasta. O mesmo para redução de mapa, você pode não necessariamente precisar, mas há casos em que você precisa.

Esses plug-ins ou complementos? Eu não usaria esse termo. Plugins e complementos têm uma integração específica com o aplicativo principal. Por exemplo, não se espera que um plug-in seja executado de forma independente, mas hospedado no aplicativo principal. Por outro lado, contribcontém ferramentas que provavelmente podem ser executadas de forma independente.

Destina-se a bibliotecas ou componentes que contribuem para o projeto, mas não pertencem ou fazem parte do próprio projeto. Eu sempre o usei como um local comum ou compartilhado para colocar as bibliotecas de terceiros que estou usando.

Por exemplo, você pode ter:

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

Em seguida, faça referência a eles em cada um dos componentes do projeto usando caminhos relativos, para que não haja nenhum tipo de instalação ou configuração necessária antes da construção. Ele será construído diretamente a partir do repositório, não importa onde o check-out seja feito localmente.

Git é um ótimo exemplo de software de código aberto que usa esta convenção:

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

Aqui está um trecho relevante desse arquivo README.md:

Software Contribuído

Embora essas peças estejam disponíveis como parte da árvore oficial de fontes git, elas estão em um status um pouco diferente. A intenção é manter ferramentas interessantes em torno do git aqui, talvez até experimentais, para oferecer aos usuários um acesso mais fácil a eles e dar uma maior exposição às ferramentas, para que possam ser melhoradas mais rapidamente.

Eu não estou esperando tocar nelas tanto assim. No que diz respeito à minha operação diária, esses subdiretórios são de propriedade de seus respectivos autores principais. Estou disposto a ajudar se os usuários desses componentes e os "proprietários" da contrib / subárvore tiverem problemas técnicos / de design a resolver, mas a iniciativa de corrigir e / ou melhorar as coisas deve estar do lado dos proprietários da subárvore.