Optimieren Sie die Arbeit mit Ihren Projekten auf GitHub: Machen Sie sich mit dem Github Template Repository vertraut

Hallo zusammen, JavaRush-Community! Heute sprechen wir über Open Source und darüber, was es braucht, um ZUSÄTZLICH zum geschriebenen Code ein hochwertiges Projekt zu erstellen . Es ist wichtig, ein nützliches Produkt zu schreiben. Aber nicht weniger wichtig ist die richtige Gestaltung des Repositorys (Projekt-Repository auf GitHub). Dies wird bei der Umsetzung eines weiteren wichtigen Punktes helfen – der Produktwerbung. Selbst wenn das Projekt super cool ist, aber schlecht gestaltet ist, wird es zumindest nicht in der README-Datei beschrieben (Sie können hier nachlesen, was eine README-Datei ist ), die Lizenz wird nicht angegeben usw. usw., es wird eine geben Kein Erfolg. Es ist nur so, dass ihn niemand bemerken wird. Und wenn jemand es bemerkt, weiß er nicht, wie er mit ihm interagieren soll. Es gibt viele Dinge, die immer wieder ausgefüllt werden müssen, und es ist für den Programmierer nicht einfach, sie jedes Mal zu kopieren und einzufügen. Genau dafür hat GitHub diesen Sommer die Template Repository- Funktion veröffentlicht, die dabei hilft. Sozusagen, um den Prozess der Erstellung neuer Projekte zu automatisieren. Heute werden wir verstehen, was ein Repository ist und was ein Vorlagen-Repository ist. Wir beschreiben, was außer dem Code im Projekt enthalten sein sollte und auf welche Dinge Sie sich konzentrieren müssen. Lassen Sie uns ein Vorlagen-Repository von Grund auf erstellen und alles hinzufügen, was aus meiner Sicht notwendig ist. Und schließlich werden wir das Template Repository verwenden, wenn wir ein neues Repository erstellen. Aber zuerst wollen wir die Begriffe verstehen. Theorie: Was sollte sich im allgemeinen Repository eines Projekts befinden? Jedes Open-Source-Projekt auf GitHub sollte über ein gut beschriebenes Community-Profil verfügen , das die folgenden Elemente enthält.

1. Issue-Vorlage

Hier müssen Sie die Regeln für die Erstellung eines Issues im Repository beschreiben: wie sie heißen sollen, wie die Bezeichnung lautet und wer ihr zugewiesen wird. Beim Erstellen einer neuen Ausgabe werden folgende Optionen angeboten:

• Fehlerbericht – Erstellen eines Problems zur Beschreibung eines Fehlers im Projekt;
• Feature-Anfrage – Vorschlag einer neuen Idee für ein Projekt;
• Verbesserungsanfrage – Vorschlag zur Verbesserung des Projekts;
• Benutzerdefinierte Problemvorlage – wenn andere Optionen nicht funktionieren, können Sie eine leere Vorlage verwenden.

Ein Beispiel dafür, wie das aussieht, können Sie hier sehen .

2. Lizenz

Die Lizenz, unter der das Projekt geschrieben wird. Dies ist notwendig, damit diejenigen, die das Projekt nutzen, wissen, was garantiert ist und was nicht. In der Apache-Lizenz 2.0 heißt es beispielsweise Folgendes:

3.README

Dies ist eine Beschreibung des Projekts, seine Visitenkarte. Hier sollte alles stehen, was zum Projekt gesagt werden muss. Natürlich muss es jedes Mal unter Berücksichtigung der Besonderheiten des Projekts beschrieben werden, aber die Überschriften werden dieselben sein. Zum Beispiel:

• Überblick – eine kurze Beschreibung des Projekts;
• Verwendung – wie das Projekt verwendet wird;
• Bauen – wie man ein Projekt startet, was dafür benötigt wird;
• Fehlerbehebung – Hier wird beschrieben, auf welche Probleme Sie möglicherweise stoßen und wie Sie sie lösen können.
• Versionshinweise – Beschreibung der Änderungen je nach Version;
• Autoren – vergessen Sie nicht Ihre Lieben;
• Mitwirken – eine Beschreibung, wie Sie sich an der Entwicklung des Projekts beteiligen können;
• Verhaltenskodex – Beschreibung der Teilnahmeregeln;
• RELEASE_NOTES – eine Datei, in der alle Änderungen für neue Versionen aufgezeichnet werden. Es empfiehlt sich, dies in ein separates Dokument zu schreiben und einen Link in der README-Datei zu speichern;
• CONTRIBUTING ist eine Datei, die beschreibt, wie Sie zur Entwicklung dieses Projekts beitragen können. Als separate Datei für den Contributing-Header in der README-Datei erstellt;
• CODE_OF_CONDUCT – eine Datei, die die Regeln für die Teilnahme an der Entwicklung des Projekts beschreibt;
• Pull-Request-Vorlage – eine Vorlage für diejenigen, die einen Pull-Request erstellen.

All diese Dinge werden von Projekt zu Projekt verwendet, unabhängig von der Programmiersprache oder ihren Besonderheiten.

Übung: Erstellen Sie Ihre eigene Vorlage

Wie man so schön sagt: Lassen Sie uns den Worten Taten folgen lassen. Nun zeige ich Ihnen anhand eines Beispiels, wie Sie eine eigene Vorlage erstellen.

1. Als erstes benötigen Sie einen Account auf GitHub bzw. registrieren Sie sich dort .

2. Erstellen Sie ein neues Repository: Klicken Sie dazu oben rechts auf +

3. Füllen Sie beim Erstellen Folgendes aus:

   • Repository-Name – in meinem Fall Repository-Vorlage;
   • Beschreibung – kurze Beschreibung des Projekts;
   • Wir belassen „Öffentlich“, obwohl Sie „Privat“ auswählen können.
   • Aktivieren Sie das Kontrollkästchen README-Initialisierung:

   • Wählen Sie die Lizenz aus, unter der das Projekt stehen soll:

     Da in meinem Fall die Vorlage allgemein ist, wird Gitignore nicht benötigt: Es wird für ein bestimmtes Projekt und eine bestimmte Programmiersprache hinzugefügt.

     Klicken Sie daher auf Repository erstellen und schließen Sie damit den Erstellungsprozess ab. Das System führt uns automatisch zum neu erstellten Repository.

4. Ausfüllen des Community-Profils : Gehen Sie im erstellten Repository zur Registerkarte „Einblicke“ und wählen Sie „Community“ aus :

   Wie Sie sehen, müssen nur noch die Vorlagen „Verhaltenskodex“, „Mitwirken“, „Issue-Vorlage“ und „Pull-Request“ ausgefüllt werden.

   Am Beispiel eines Verhaltenskodex zeigen wir, wie man diese in ein Projekt einfügt.

   Klicken Sie auf „Hinzufügen“ . Das System fordert Sie auf, „Contributor Covenant“ oder „Bürger-Verhaltenskodex“ auszuwählen :

   Ich wähle das erste aus und klicke auf „Überprüfen und senden“ .

   Als nächstes können Sie diese Datei bearbeiten und festschreiben.

   Wählen Sie unten die Option „Direkt an den Hauptzweig übergeben“ aus und klicken Sie auf „Neue Datei übergeben“ :

   Wenn wir daher zum Community-Profil zurückkehren , werden wir feststellen, dass der Verhaltenskodex als hinzugefügt markiert ist:

   „Mitwirken“ und „Problemvorlage“ werden auf ähnliche Weise hinzugefügt, daher werde ich dies nicht zeigen. Mach es selbst ;)

5. Pull-Request-Vorlage hinzufügen .

   Aber lassen Sie uns darüber gesondert sprechen.

   Ich weiß nicht, warum GitHub nicht die gleiche praktische Option zum Einrichten der Pull-Request-Vorlage hinzugefügt hat. Sie müssen also die Dokumentation studieren und sie manuell hinzufügen.

   Klicken Sie dazu im Stammverzeichnis des Repositorys auf Neue Datei erstellen :

   Der Dateiname sollte sein: .github/pull_request_template.md .

   Wir fügen der Vorlage hinzu, was wir brauchen, und klicken auf Neue Datei übertragen , wie wir es oben getan haben. Ich wollte das Rad nicht neu erfinden und habe ein Beispiel gefunden , das mir durchaus brauchbar erschien.

   Auf diese Weise wird das gesamte Community-Profil ausgefüllt:

6. Fügen Sie eine Vorlage-Repository- Markierung hinzu .

   Gehen Sie dazu im Repository zur Option „Einstellungen“ und aktivieren Sie das Kontrollkästchen „Vorlagen-Repository“:

   Und fertig, die Vorlage zum Erstellen neuer Projekte ist fertig. So sparen wir in Zukunft viel Zeit, wenn wir neue Projekte erstellen müssen. Dies hilft Ihnen auch dabei, wichtige Details nicht zu verpassen, da es häufig vorkommt, dass Sie vergessen, etwas hinzuzufügen, beispielsweise eine Lizenz oder eine klare Vorlage für ein Problem.

So verwenden Sie das Vorlagen-Repository

Für die Nutzung gibt es zwei Möglichkeiten:

1. Wenn eine Vorlage direkt Ihnen gehört: Wenn Sie ein neues Repository erstellen, haben Sie die Möglichkeit, aus einer Vorlage aus der Liste der Vorlagen, die Sie besitzen, zu erstellen:

2. Bei fremder Vorlage: Auch hier gibt es keine besonderen Probleme. Gehen Sie zu dieser Vorlage und klicken Sie auf die Schaltfläche „Diese Vorlage verwenden“ . Hier verwende ich die Animation aus dem offiziellen Dokument:

Fassen wir es zusammen

In diesem Artikel haben wir uns Folgendes angesehen:

• Was ist das GitHub-Repository?
• Was ist das Vorlagen-Repository?
• Was sollte im Vorlagen-Repository enthalten sein?
• wie man ein Vorlagen-Repository erstellt;
• wie man das Template Repository verwendet.

Selbstverständlich können Sie auf Basis dieser Vorlage bereits konkretere Vorlagen erstellen. Ich habe beispielsweise weitere Vorlagen mit bereits konfigurierten Maven- oder Gradle- Build-Systemen erstellt. Darüber hinaus können Sie eine Spring Boot Repository-Vorlage basierend auf den letzten beiden erstellen. Um alle Vorlagen zu gruppieren, habe ich auf GitHub eine Vorlagen-Repository- Organisation mit allen Vorlagen erstellt. Abonnieren Sie mein GitHub-Konto

Nützliche Links

• Organisation mit allen von mir erstellten Vorlagen
• GitHub-Blog: Neues Repository mit Repository-Vorlagen erstellen, wie man eine Vorlage für Repositorys erstellt
• GitHub-Hilfe: Über Repositories, was Repositories sind.
• GitHub-Hilfe: Erstellen eines Repositorys aus einer Vorlage, wie man ein neues Projekt basierend auf einer Vorlage erstellt
• GitHub-Hilfe: Lizenzierung einer Repository- Beschreibung der Lizenzierung für Projekte
• GitHub-Hilfe: Erstellen Sie eine Repo- Beschreibung zum Erstellen eines Repositorys
• Open Source Guides- Tipps zum Erstellen/Beschreiben von Open-Source-Projekten.
• GitHub-Hilfe: Hinzufügen einer Pull-Request-Vorlage – Erstellen einer Vorlage für Pull-Requests.

Weitere meiner Artikel

• Debuggen in Intellij IDEA: eine Anleitung für Anfänger
• Leitfaden zum Erstellen eines Clients für die Skyscanner-API und zum Veröffentlichen in jCenter und Maven Central [Teil 1]
• Leitfaden zum Erstellen eines Clients für die Skyscanner-API und zum Veröffentlichen in jCenter und Maven Central [Teil 2]
• Erstellen eines Systems zur Überwachung der Flugticketpreise: eine Schritt-für-Schritt-Anleitung [Teil 1]
• Erstellen eines Systems zur Überwachung der Flugticketpreise: eine Schritt-für-Schritt-Anleitung [Teil 2]
• Erstellen eines Systems zur Überwachung der Flugticketpreise: eine Schritt-für-Schritt-Anleitung [Teil 3]
• Protokollierung: Was, wie, wo und womit?
• Wie aus einem Interviewtest eine Open-Source-Bibliothek wurde
• Erfolgsgeschichte. 20 Stunden Programmieren pro Woche, Master-Abschluss und Privatleben
• Wie finde ich einen Job? Tipps zum Versenden von Lebensläufen