gitignore

Eine Sammlung von Vorlagen von .gitignore

Dies ist Githubs Sammlung von .gitignore -Dateivorlagen. Wir verwenden diese Liste, um die in der github.com -Schnittstelle verfügbaren .gitignore -Vorlagen -Chooser beim Erstellen neuer Repositories und Dateien zu füllen.

Weitere Informationen darüber, wie .gitignore -Dateien funktionieren und wie Sie sie verwenden, sind die folgenden Ressourcen ein guter Ausgangspunkt:

• Das Kapitel "Dateien ignorieren" des Pro Git -Buches.
• Der Artikel von Dateien auf der GitHub Help -Site.
• Die Handbuchseite Gitignore (5).

Ordnerstruktur

Wir unterstützen eine Sammlung von Vorlagen, die auf diese Weise organisiert sind:

• Der Root -Ordner enthält Vorlagen gemeinsam, um den Menschen dabei zu helfen, mit beliebten Programmiersprachen und -technologien zu beginnen. Diese definieren eine aussagekräftige Reihe von Regeln, um zu beginnen, und stellen sicher, dass Sie keine unwichtigen Dateien in Ihr Repository verpflichten.
• Global enthält Vorlagen für verschiedene Redakteure, Tools und Betriebssysteme, die in verschiedenen Situationen verwendet werden können. Es wird empfohlen, diese entweder zu Ihrer globalen Vorlage hinzuzufügen oder diese Regeln in Ihre projektspezifischen Vorlagen zusammenzufassen, wenn Sie sie dauerhaft verwenden möchten.
• community enthält spezielle Vorlagen für andere beliebte Sprachen, Tools und Projekte, die derzeit nicht in die Mainstream -Vorlagen gehören. Diese sollten zu Ihren projektspezifischen Vorlagen hinzugefügt werden, wenn Sie sich für das Framework oder Tool entscheiden.

Was macht eine gute Vorlage aus?

Eine Vorlage sollte eine Reihe von Regeln enthalten, um Git -Repositorys mit einer bestimmten Programmiersprache, einem bestimmten Rahmen, einem Werkzeug oder einer bestimmten Umgebung zu helfen.

Wenn es nicht möglich ist, eine kleine Reihe nützlicher Regeln für diese Situation zu kuratieren, passt die Vorlage nicht gut zu dieser Sammlung.

Wenn eine Vorlage hauptsächlich eine Liste von Dateien ist, die durch eine bestimmte Version einer Software (z. B. ein PHP -Framework) installiert werden, kann sie im community -Verzeichnis leben. Weitere Informationen finden Sie unter den versionierten Vorlagen.

Wenn Sie eine kleine Reihe von Regeln haben oder eine Technologie unterstützen möchten, die nicht weit verbreitet ist, und dennoch glauben, dass dies für andere hilfreich ist, lesen Sie bitte den Abschnitt über spezielle Vorlagen für weitere Informationen.

Geben Sie Details beim Öffnen der Pull -Anfrage an, wenn die Vorlage wichtig und sichtbar ist. Wir können es möglicherweise nicht sofort akzeptieren, aber wir können es zu einem späteren Zeitpunkt auf der Grundlage von Interesse zur Wurzel fördern.

Bitte verstehen Sie auch, dass wir nicht jedes Tool auflisten können, das jemals existiert. Unser Ziel ist es, eine Sammlung der häufigsten und hilfsbereitsten Vorlagen zu kuratieren, um nicht sicherzustellen, dass wir jedes mögliche Projekt abdecken. Wenn wir Ihre Sprache, Ihr Tool oder Ihr Projekt nicht einbeziehen, liegt es nicht daran, dass es nicht großartig ist.

Richtlinien beitragen

Wir würden uns freuen, wenn Sie dieses Projekt verbessern können. Um uns zu helfen, diese Sammlung qualitativ zu halten, fordern wir, dass Beiträge die folgenden Richtlinien einhalten.

• Geben Sie einen Link zur Anwendung oder der Homepage des Projekts an . Sofern es nicht äußerst beliebt ist, besteht die Möglichkeit, dass die Betreuer die Sprache, den Framework, die Herausgeber, die App oder das Projekt verwenden, auf das Ihre Änderung gilt.

• Geben Sie Links zur Dokumentation an, die die Änderung unterstützen, die Sie vornehmen. Aktuelle kanonische Dokumentation, die die ignorierten Dateien erwähnt, ist am besten. Wenn die Dokumentation nicht verfügbar ist, um Ihre Änderung zu unterstützen, können Sie das Beste tun, um zu erklären, wofür die Dateien ignoriert werden.

• Erklären Sie, warum Sie eine Änderung vornehmen . Auch wenn es selbstverständlich erscheint, nehmen Sie bitte einen oder zwei Satz, um uns mitzuteilen, warum Ihre Änderung oder Ergänzung stattfinden sollte. Es ist besonders hilfreich zu artikulieren, warum diese Änderung für alle gilt, die mit der anwendbaren Technologie arbeiten, und nicht nur für Sie oder Ihr Team.

• Bitte betrachten Sie den Umfang Ihrer Veränderung . Wenn Ihre Änderung für eine bestimmte Sprache oder einen bestimmten Framework spezifisch ist, stellen Sie sicher, dass die Änderung an der Vorlage für diese Sprache oder dieses Framework vorgenommen wird, und nicht in der Vorlage für einen Editor, ein Tool oder ein Betriebssystem.

• Bitte ändern Sie nur eine Vorlage pro Pull -Anfrage . Dies hilft, Anfragen und Rückmeldungen auf ein bestimmtes Projekt oder eine bestimmte Technologie zu halten.

Je mehr Sie tun können, um uns zu verstehen, um die Veränderung zu verstehen, die Sie vornehmen, desto wahrscheinlicher werden wir Ihren Beitrag schnell akzeptieren.

Versionsvorlagen

Einige Vorlagen können sich zwischen den Versionen stark ändern. Wenn Sie zu diesem Repository beitragen möchten, müssen wir diesen spezifischen Fluss befolgen:

• Die Vorlage am Root sollte die aktuell unterstützte Version sein
• Die Vorlage am Root sollte keine Version im Dateinamen haben (dh "Evergreen")
• Frühere Versionen von Vorlagen sollten unter community/
• Frühere Versionen der Vorlage sollten die Version in den Dateinamen einbetten, um die Lesbarkeit zu erhalten

Dies hilft sicherzustellen, dass Benutzer die neueste Version erhalten (da sie alles verwenden, was auch immer am Root ist), hilft jedoch die Unterstützung von Wartungspersonen, ältere Versionen noch in freier Wildbahn.

Spezialvorlagen

Wenn Sie eine Vorlage haben, die Sie beisteuern möchten, aber sie ist nicht ganz Mainstream, sollten Sie dies in das community -Verzeichnis unter einem Ordner hinzufügen, der am besten passt, wo es hingehört.

Die Regeln in Ihrer speziellen Vorlage sollten spezifisch für das Framework oder das Tool sein, und zusätzliche Vorlagen sollten in einem Kommentar im Header der Vorlage erwähnt werden.

Beispielsweise kann diese Vorlage bei community/DotNet/InforCRM.gitignore leben:

 # gitignore template for InforCRM (formerly SalesLogix)
# website: https://www.infor.com/product-summary/cx/infor-crm/
#
# Recommended: VisualStudio.gitignore

# Ignore model files that are auto-generated
ModelIndex.xml
ExportedFiles.xml

# Ignore deployment files
[Mm]odel/[Dd]eployment

# Force include portal SupportFiles
!Model/Portal/*/SupportFiles/[Bb]in/
!Model/Portal/PortalTemplates/*/SupportFiles/[Bb]in

Workflow beitragen

So empfehlen wir, dass Sie eine Änderung dieses Projekts vorschlagen:

1. Geben Sie dieses Projekt auf Ihr Konto.
2. Erstellen Sie einen Zweig für die Änderung, die Sie vornehmen möchten.
3. Nehmen Sie Ihre Änderungen an Ihrer Gabel vor.
4. Senden Sie eine Pull -Anfrage von der Zweigstelle Ihrer Gabel an unsere main .

Die Verwendung der webbasierten Schnittstelle, um Änderungen vorzunehmen, ist auch in Ordnung und hilft Ihnen, indem Sie das Projekt automatisch verlassen und auffordern, auch eine Pull-Anfrage zu senden.

Lizenz

CC0-1.0.