Co znajduje się w folderze „contrib”?

Często projekty oprogramowania open source mają folder o nazwie „contrib”. Na przykład Django ma jeden . Po co to jest?

Jest za oprogramowanie, które zostało contrib oddziaływał na projekcie, ale nie w rzeczywistości może być utrzymana przez twórców bazowych. Nazywanie go „contrib” lub „Contrib” jest od dawna przyjętą konwencją, ale tak naprawdę nie ma w tym nic specjalnego, a zwykle używa się go tylko w dość dużych projektach.

Patrząc na popularne projekty open source, które przychodzą na myśl, nie widzę wzmianki o żadnym folderze „contrib”:

• jQuery ,
• Ekspresowe ,
• Sass ,
• mNIEJ ,
• MongoDB ,
• Redis ,
• Marionetka ,
• Szef kuchni
• NUnit ,
• Ruby on Rails ,
• Laravel ,
• Jenkins ,
• Clojure ,
• Ruby .

Jedynym, który ma folder „contrib” jest Django. W przypadku Django rola tego folderu została już wyjaśniona w dokumentacji :

Django dąży do przestrzegania filozofii Pythona „dołączone baterie”. Dostarczany jest z szeregiem dodatkowych, opcjonalnych narzędzi, które rozwiązują typowe problemy z tworzeniem stron internetowych.

Ten kod znajduje się w django/contribdystrybucji Django. Ten dokument zawiera podsumowanie pakietów w contrib, wraz z wszelkimi zależnościami, jakie mają te pakiety.

Rozdział 16 Księgi Django zawiera bardziej szczegółowy opis roli tego katalogu i spis treści.

Innym przykładem jest Solr . Dzięki gitstatsmożemy uzyskać statystyki dotyczące autorów.

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%

Następnie możemy wybrać tylko contribkatalog, uruchamiając:

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

i uzyskaj statystyki jeszcze raz:

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

Zatem najlepsi autorzy są praktycznie tacy sami, co oznacza, że ​​nie są to wypowiedzi osób postronnych. Patrząc na katalogi w contribfolderze, wydaje się, że po raz kolejny są to „różnorodne dodatkowe, opcjonalne narzędzia”, dokładnie tak jak w Django. Na przykład nie potrzebujesz modułu obsługi żądania importu danych, aby Solr działał, ale jeśli chcesz importować dane z bazy danych lub XML, dobrze jest mieć je w contribfolderze. To samo dotyczy zmniejszania mapy, niekoniecznie będziesz jej potrzebować, ale są przypadki, w których to robisz.

Czy to są wtyczki lub dodatki? Nie użyłbym tego terminu. Wtyczki i dodatki mają specyficzną integrację z główną aplikacją. Na przykład wtyczka nie powinna działać autonomicznie, ale będzie hostowana w głównej aplikacji. Z drugiej strony contribzawiera narzędzia, które prawdopodobnie mogą działać samodzielnie.

Jest przeznaczony dla bibliotek lub komponentów, które wnoszą wkład do projektu, ale nie są własnością ani częścią samego projektu. Zawsze używałem go jako wspólnej lub współdzielonej lokalizacji do umieszczania dowolnych bibliotek stron trzecich, których używam.

Na przykład możesz mieć:

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

Następnie odwołaj się do nich w każdym ze składników projektu, używając ścieżek względnych, aby nie było potrzeby instalowania ani konfigurowania przed budowaniem. Będzie budować bezpośrednio z repozytorium bez względu na to, gdzie jest sprawdzane lokalnie.

Git jest doskonałym przykładem oprogramowania typu open source, które korzysta z tej konwencji:

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

Oto odpowiedni fragment tego pliku README.md:

Oprogramowanie wnoszone

Chociaż te elementy są dostępne jako część oficjalnego drzewa źródeł git, mają nieco inny status. Chodzi o to, aby trzymać tutaj interesujące narzędzia, może nawet eksperymentalne, aby zapewnić użytkownikom łatwiejszy dostęp do nich i dać narzędziom szerszą ekspozycję, aby można je było szybciej ulepszyć.

Nie oczekuję, że dotknę ich tak bardzo. Jeśli chodzi o moją codzienną działalność, te podkatalogi są własnością ich głównych autorów. Jestem gotów pomóc, jeśli użytkownicy tych komponentów i „właściciele” kontrybutu / poddrzewa mają problemy techniczne / projektowe do rozwiązania, ale inicjatywa naprawy i / lub ulepszenia musi być po stronie właścicieli poddrzewa.