Community

Beteiligen auch Sie sich an der Community

Wir würden uns freuen, wenn Sie zu unserem Quellcode beitragen und iText 7 Community noch besser machen, als es heute ist!

Beitrag zur iText 7 Community

Wir würden uns freuen, wenn Sie zu unserem Quellcode beitragen und iText 7 Community noch besser machen, als es heute ist! Hier sind die Richtlinien, die Sie bitte befolgen sollten:

Haben Sie Fragen oder Schwierigkeiten?

Wenn Sie Fragen zur Nutzung der iText 7 Community haben, richten Sie diese bitte an Stack Overflow.

Wenn Sie ein Kunde mit einer Support-Vereinbarung sind, haben Sie auch direkten Zugang zu unserer JIRA und unseren Entwicklern.

Auf ein Problem gestoßen?

Wenn Sie einen Fehler im Quellcode oder einen Fehler in der Dokumentation finden, können Sie uns helfen, indem Sie eine Pull-Anfrage mit einer Korrektur einreichen.

Bitte beachten Sie die Einreichungsrichtlinien unten.

Möchten Sie eine Funktion implementieren?

Falls Sie eine neue Funktion implementieren möchten, dann überlegen Sie, um welche Art von Änderung es sich handelt:

  • Größere Änderungen, die Sie in das Projekt einbringen möchten, sollten zuerst besprochen werden, damit wir unsere Bemühungen besser koordinieren, Doppelarbeit vermeiden und Ihnen helfen können, die Änderung so zu gestalten, dass sie erfolgreich in das Projekt aufgenommen wird. Kontaktieren Sie uns unter community@itextpdf.com.
  • Kleine Änderungen können ausgearbeitet und als Pull-Anfrage an das GitHub-Repository übermittelt werden.

Richtlinien zur Einreichung

Einreichen einer Frage oder eines Problems

Bevor Sie Ihre Frage oder Ihr Problem einreichen, suchen Sie Stack Overflow, vielleicht wurde Ihre Frage bereits beantwortet.

Wenn Ihr Problem ein Fehler zu sein scheint und nicht gemeldet wurde, stellen Sie eine Frage zu Stack Overflow, um zu überprüfen, ob es sich tatsächlich um einen Fehler und nicht um einen Irrtum in Ihrem eigenen Code handelt. Helfen Sie uns, den Aufwand, den wir für die Behebung von Problemen und das Hinzufügen neuer Funktionen aufwenden können, zu maximieren, indem Sie keine redundanten Probleme melden. Wenn Sie die folgenden Informationen zur Verfügung stellen, erhöhen Sie die Chancen, dass Ihr Problem schnell behandelt wird:

  • Wie man gute Fragen stellt
  • Überblick des Problems - wenn ein Fehler ausgeworfen wird, hilft eine nicht reduzierte Stapelverfolgung
  • Motivation für oder Anwendungsfall - erklären Sie, warum dies ein Fehler für Sie ist
  • iText Version(en) - Ist es ein Rückschritt?
  • Betriebssystem - Ist dies ein Problem unter Windows oder Linux, vielleicht unter Mac?
  • Reproduzieren Sie den Fehler - Stellen Sie ein kurzes, in sich geschlossenes, korrektes (kompilierbares) Beispiel zur Verfügung, das auch als minimales, vollständiges und überprüfbares Beispiel bekannt ist.
  • Artverwandte Probleme - Wurde bereits über ein ähnliches Problem berichtet?
  • Eine Lösung vorschlagen - wenn Sie den Fehler nicht selbst beheben können, können Sie vielleicht auf die Ursache des Problems hinweisen (Codezeile oder Commit)
  • Markieren Sie die Frage - Fügen Sie den Tag itext7 zu Ihrer Frage hinzu, damit wir sie finden können.

Helfen Sie anderen, wenn Sie Hilfe bekommen. Gutes Karma triumphiert!

Einreichen einer Pull-Anfrage

Bevor Sie Ihre Pull-Anfrage einreichen, beachten Sie die folgenden Richtlinien:

  • Suchen Sie in GitHub nach einer offenen oder geschlossenen Pull-Anfrage, die sich auf Ihre Einreichung bezieht. Es sollte möglichst kein unnötiger Aufwand entstehen.
  • Stellen Sie sicher, dass Ihre vorgeschlagene Änderung nicht bereits im Entwicklungszweig behandelt wurde.
  • Senden Sie nicht für jede einzelne Datei, die Sie ändern, eine separate Pull-Anfrage.
  • Bitte unterzeichnen Sie die iText-Lizenzvereinbarung für Dienstleister (iCLA), bevor Sie Pull-Anfragen für Änderungen von mehr als 20 signifikanten Codezeilen senden (wir zählen geschweifte Klammern und andere syntaktische Zucker nicht mit). Ohne diese Vereinbarung können wir keinen Code akzeptieren.
  • Spalten Sie das iText-Repository auf GitHub ab.
  • Klonen Sie Ihre iText-Abspaltung auf Ihren lokalen Rechner.
  • Führen Sie Ihre Änderungen durch, einschließlich geeigneter Testfälle.
  • Folgen Sie unsere Kodierungsregeln.
  • Übertragen Sie Ihre Änderungen mit einer beschreibenden Commit-Mitteilung, die unseren Commit-Mitteilungs-Konventionen folgt.
  • Jetzt wäre ein guter Zeitpunkt, Ihre Commits (wenn Sie wollen oder müssen) mit git rebase --interaktiv zu reparieren.
  • Erstellen Sie Ihre Änderungen lokal, um sicherzustellen, dass alle Tests bestanden werden.
  • Ziehen Sie Ihre Änderungen auf Ihr GitHub-Konto.
  • Erstellen Sie eine Pull-Anfrage in GitHub.

„Head fork“ sollte Ihr Repository sein, und die „Base fork“ sollte das offizielle iText7-Repository sein.

  • Falls wir Änderungen vorschlagen:
    • Führen Sie die erforderlichen Updates durch.
    • Richten Sie Ihre Commits bei Bedarf mit einer interaktiven Rebase ein.
    • Führen Sie die Tests erneut durch und stellen Sie sicher, dass sie immer noch bestanden werden.
    • Erzwingen Sie das Ziehen auf Ihr GitHub-Repository. Dies wird Ihre Pull-Anfrage aktualisieren.

Das war's! Danke für Ihren Beitrag!

Nachdem Ihre Pull-Anfrage zusammengefügt ist

Nachdem Ihre Pull-Anfrage zusammengefügt wurde, können Sie Ihre Abspaltung sicher löschen und die Änderungen aus dem Haupt-Repository (Upstream) ziehen.

Kodierungsregeln

Um die Konsistenz des gesamten Quellcodes zu gewährleisten, sollten Sie diese Regeln bei Ihrer Arbeit beachten:

  • Wir entwickeln zuerst in Java und portieren dann nach .NET, daher werden Codeeinreichungen in Java bevorzugt. Das sollte Sie jedoch nicht davon abhalten, eine gute Pull-Anfrage an den .NET-Port zu stellen.
  • Der gesamte Java-Code muss Java 7 sein. Tut mir leid, keine Lambda-Ausdrücke oder andere Java 8-Sprachfunktionen.
  • Alle Funktionen oder Fehlerbehebungen müssen durch einen oder mehrere Einheitstests getestet werden.
  • Alle öffentlichen API-Methoden müssen mit JavaDoc dokumentiert werden. Um zu sehen, wie wir unsere APIs dokumentieren, sehen Sie sich bitte die vorhandenen Javadocs an.
  • Wir befolgen die Regeln, die in Oracle's Code Conventions for the Java Programming Language enthalten sind, mit diesen Ergänzungen:
    • Den gesamten Code mit 100 Zeichen umbrechen.

Richtlinien für Git-Commit

Wir haben Richtlinien, wie unsere Git-Commit-Mitteilungen formatiert werden sollten. Dies führt zu besser lesbaren Mitteilungen, die beim Durchsehen der Projektgeschichte leicht zu verfolgen sind. Wir verwenden die Git-Commit-Mitteilungen aber auch, um das Änderungsprotokoll der iText 7-Community zu erstellen.

Diese Richtlinien wurden Chris Beams' Blog-Posting How to Write a Git Commit Message (Wie schreibt man eine Git-Commit-Mitteilung?) entnommen.

Format der Commit-Mitteilung

Jede Mitteilung besteht aus einem Betreff, einem Hauptteil und einer Fußzeile:

<subject>
<BLANK LINE>
<body>
<BLANK LINE>
<footer>

Jede Zeile der Commit-Mitteilung sollte nicht länger als 72 Zeichen sein! Dadurch wird die Mitteilung sowohl auf GitHub als auch in verschiedenen Git-Tools leichter lesbar.

Betreff

Der Betreff enthält eine prägnante Beschreibung der Änderung:

Hauptteil

Die Fußzeile enthält alle Informationen über das Brechen von Änderungen und ist auch der Ort, an dem auf JIRA- oder GitHub-Probleme verwiesen wird, die dieses Commit abschließt.

Unterzeichnung des iCLA

Bitte unterzeichnen Sie die iText-Lizenzvereinbarung für Dienstleister (iCLA), bevor Sie Pull-Anfragen senden. Damit größere Code-Änderungen (mehr als 20 Zeilen signifikanter Code) akzeptiert werden können, muss der iCLA unterzeichnet werden. Es ist ein schneller Prozess, das versprechen wir!

Sie müssen das Formular (digital) unterzeichnen und dann per E-Mail, Fax oder Post versenden.

Verhaltenskodex für Dienstleister

Bitte beachten Sie, dass dieses Projekt mit einem Verhaltenskodex für Dienstleister veröffentlicht wird. Mit der Teilnahme an diesem Projekt erklären Sie sich einverstanden, sich an seine Bedingungen zu halten.

Wir verwenden das Stack Exchange-Netzwerk für kostenlosen Support und GitHub für das Code-Hosting. Mit der Nutzung dieser Dienste erklären Sie sich mit deren Bedingungen einverstanden:

Kontakt

Haben Sie noch weitere Fragen? 

Gerne beantworten wir Ihre Fragen. Kontaktieren Sie uns und wir werden uns in Kürze mit Ihnen in Verbindung setzen.

Bitte kontaktieren Sie uns
Auf dem Laufenden bleiben

Melden Sie sich mit mehr als 11.000 Abonnenten an und werden Sie ein iText PDF-Experte, indem Sie sich über unsere neuen Produkte, Updates, Tipps, technischen Lösungen und Veranstaltungen informieren.

Abonniere jetzt