Beitragsleitfaden¶
Es gibt viele Möglichkeiten, zu BeeWare beizutragen. Diese Anleitungen enthalten alles, was Sie wissen müssen, um Ihren Beitrag zu leisten.
Was kann ich tun?¶
Ein Problem beheben¶
Der offensichtlichste Beitrag, den Sie leisten können, ist Code zur Behebung eines bekannten Problems schreiben.
Implementierung einer neuen Funktion¶
Fehlt BeeWare eine Funktion, die Sie gerne sehen würden? Sie können eine neue Funktion einführen.
Write documentation¶
Keine Funktion ist vollständig, wenn sie nicht gut dokumentiert ist. Das Schreiben von Dokumentation ist eine Möglichkeit, einen Beitrag zu leisten, ohne dass man Code schreiben muss.
Triage eines Problems¶
Jedes Mal, wenn jemand ein neues Problem meldet, muss dieses Problem behandelt werden. [Bei der Bearbeitung eines Problems (what/triage.md) geht es darum, die vom Meldenden bereitgestellten Informationen zu nutzen und zu versuchen, das beschriebene Problem zu reproduzieren.
Eine Pull-Anfrage überprüfen¶
Sobald ein Pull Request eingereicht wurde, muss er überprüft werden, bevor er zusammengeführt werden kann. Unabhängig davon, ob Sie mit dem Inhalt bestens vertraut sind, gibt es wahrscheinlich eine Möglichkeit, wie Sie bei der [Überprüfung eines Pull Requests] helfen können (what/review-pr.md).
Eine neue Funktion vorschlagen¶
Haben Sie einen Vorschlag oder eine Idee für eine neue Ergänzung zu einem der BeeWare-Tools? Sie können eine neue Funktion vorschlagen, um sie zu prüfen.
Inhalt übersetzen¶
BeeWare unterhält verschiedene Dokumentationen in mehreren Sprachen. Wenn Sie eine andere Sprache als Englisch beherrschen, können Sie bei der Übersetzung von Inhalten helfen.
Benutze die Werkzeuge¶
Haben Sie eine Idee für eine mit Toga entwickelte Anwendung? Haben Sie eine bestehende Anwendung, die mit Briefcase verpackt werden könnte? Sie können die Tools nutzen und uns Feedback zu Ihren Erfahrungen geben.
Wie kann ich einen Beitrag leisten?¶
Einrichten einer Entwicklungsumgebung¶
Bevor Sie einen Beitrag zu BeeWare leisten können, müssen Sie Ihre Entwicklungsumgebung einrichten.
Ein Problem reproduzieren¶
Bevor Sie ein Problem beheben, müssen Sie überprüfen, ob es existiert. Das Reproduzieren eines Problems ist ebenfalls ein wichtiger Teil der Triage.
Arbeiten Sie von einem Zweig aus¶
Wenn Sie einen Beitrag vorbereiten, sollten Sie immer von einer Verzweigung ausgehen.
Vermeiden Sie eine schleichende Ausweitung des Geltungsbereichs¶
Es ist wichtig, dass Sie sich auf Ihren Beitrag konzentrieren und [eine schleichende Ausweitung des Umfangs] (how/scope-creep.md) vermeiden.
Vorschlag für ein neues Merkmal¶
Führen Sie die folgenden Schritte aus, um eine neue Funktion vorzuschlagen.
Code schreiben, ausführen und testen¶
Um Code zu aktualisieren oder beizutragen, müssen Sie Ihren Code schreiben, ausführen und testen.
Dokumentation erstellen¶
Um die Dokumentation zu aktualisieren oder zu ihr beizutragen, müssen Sie in der Lage sein, die Dokumente zu erstellen.
Write documentation¶
Um zur Dokumentation beizutragen, müssen Sie neue Inhalte schreiben oder bestehende Inhalte aktualisieren.
Änderungsvermerk hinzufügen¶
Jede Pull-Anforderung sollte von einer Änderungsnotiz begleitet werden.
Einen Pull-Request einreichen¶
Sobald Ihre Änderungen fertig sind, reichen Sie eine Pull-Anfrage zur Überprüfung ein.
Geben Sie eine Bewertung ab¶
Wenn es Ihnen recht ist, können Sie den Beitrag einer anderen Person bewerten.
Inhalt übersetzen¶
BeeWare verwendet Weblate für Übersetzungen, was einige Schritte erfordert, um loszulegen.
Eine neue Ausgabe einreichen¶
Wenn Sie auf ein neues Problem oder einen neuen Fehler stoßen, ist es hilfreich, ein Problem zu melden.
Wie geht es weiter?¶
Pull request review¶
Wenn ein Pull Request eingereicht wird, ist der nächste Schritt die PR-Überprüfung.
Der Freigabeprozess¶
Zusammengeführte Beiträge durchlaufen den Freigabeprozess.
Style Guides¶
Guide Style Code¶
Dies sind die Richtlinien für das Einbringen von Code in BeeWare-Projekte.
Documentation style guide¶
Dies sind die Richtlinien für das Einbringen von Dokumentation in BeeWare-Projekte.