Du hast einen Fehler gefunden oder eine Idee für ein cooles neues Feature? Das Beisteuern von Code ist eine großartige Möglichkeit, der Open-Source-Community etwas zurückzugeben. Bevor Sie sich direkt mit dem Code befassen, gibt es ein paar Richtlinien, die wir von den Mitwirkenden befolgen müssen, damit wir den Überblick behalten können.
Stellen Sie sicher, dass Sie über ein JIRA-Konto verfügen.
Stellen Sie sicher, dass Sie über ein GitHub-Konto verfügen.
Wenn Sie die Implementierung einer neuen Funktion planen, ist es sinnvoll, Ihre Änderungen zunächst auf der Entwicklerliste zu besprechen. Auf diese Weise können Sie sicherstellen, dass Sie Ihre Zeit nicht mit etwas verschwenden, das nicht in den Anwendungsbereich von Apache Maven fällt.
Reichen Sie ein Ticket für Ihr Problem ein, sofern noch keins vorhanden ist.
Beschreiben Sie das Problem klar und deutlich, einschließlich der Schritte zur Reproduktion, wenn es sich um einen Fehler handelt.
Stellen Sie sicher, dass Sie die früheste Version ausfüllen, von der Sie wissen, dass das Problem auftritt.
Forken Sie das Repository auf GitHub.
Wir akzeptieren Pull Requests über GitHub. Die Entwickler-Mailingliste ist der Hauptkommunikationskanal für Mitwirkende.
Es gibt einige Richtlinien, die uns die Anwendung von PRs erleichtern:
Erstellen Sie einen Themenzweig, auf dem Sie Ihre Arbeit aufbauen möchten (dies ist normalerweise der Hauptzweig). Übertragen Sie Ihre Änderungen in einen Themenzweig in Ihrem Zweig des Repositorys.
Führen Sie Commits für logische Einheiten durch.
Respektieren Sie den ursprünglichen Codestil: Durch die Verwendung desselben Codestils sollten Patches nur den tatsächlichen Unterschied hervorheben und nicht durch Formatierungsprobleme beeinträchtigt werden:
Verwenden Sie zum Einrücken ausschließlich Leerzeichen.
Erstellen Sie minimale Unterschiede – deaktivieren Sie beim Speichern Aktionen wie das Neuformatieren des Quellcodes oder das Organisieren von Importen. Wenn Sie der Meinung sind, dass der Quellcode neu formatiert werden sollte, erstellen Sie eine separate PR für diese Änderung.
Überprüfen Sie vor dem Commit mit git diff --check
, ob unnötiger Leerraum vorhanden ist.
Stellen Sie sicher, dass Ihre Commit-Nachrichten das richtige Format haben. Ihre Commit-Nachricht sollte den Schlüssel des JIRA-Issue enthalten.
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
Stellen Sie sicher, dass Sie die erforderlichen Tests (JUnit/IT) für Ihre Änderungen hinzugefügt haben.
Führen Sie alle Tests mit mvn -Prun-its verify
aus, um sicherzustellen, dass nichts anderes versehentlich beschädigt wurde.
Senden Sie eine Pull-Anfrage an das Repository in der Apache-Organisation.
Aktualisieren Sie Ihr JIRA-Ticket und fügen Sie einen Link zum Pull-Request in das Ticket ein.
Wenn Sie planen, regelmäßig Beiträge zu leisten, denken Sie bitte darüber nach, eine Lizenzvereinbarung für Mitwirkende einzureichen.
Für Änderungen trivialer Art an Kommentaren und Dokumentation ist es nicht immer notwendig, ein neues Ticket in JIRA zu erstellen. In diesem Fall ist es sinnvoll, die erste Zeile eines Commits mit „(doc)“ anstelle einer Ticketnummer zu beginnen.
Beitragende Patches
Apache Maven Shared Components-Projektseite
Lizenzvereinbarung für Mitwirkende
Allgemeine GitHub-Dokumentation
GitHub-Pull-Request-Dokumentation
Apache Maven Twitter-Konto
#Maven IRC-Kanal auf freenode.org