CONTRIBUTING.md

Mitwirken an MoeShare

Zunächst einmal vielen Dank, dass du dir die Zeit nimmst, mitzuwirken! ❤️

Alle Arten von Beiträgen sind willkommen und werden geschätzt. Siehe das Inhaltsverzeichnis für verschiedene Möglichkeiten, wie du helfen kannst, und Details darüber, wie dieses Projekt damit umgeht. Bitte lies den relevanten Abschnitt, bevor du deinen Beitrag leistest. Dies wird es für uns Betreuer erleichtern und die Erfahrung für alle Beteiligten reibungsloser gestalten. Die Community freut sich auf deine Beiträge. 🎉

Und wenn dir das Projekt gefällt, du aber keine Zeit hast, beizutragen, ist das in Ordnung. Es gibt andere einfache Möglichkeiten, das Projekt zu unterstützen und deine Wertschätzung zu zeigen, über die wir uns ebenfalls sehr freuen würden:

• Gebe das Projekt ein Stern
• Verweise auf dieses Projekt in der Readme deines Projekts
• Erwähne das Projekt auf lokalen Treffen und erzähle es deinen Freunden/Kollegen

Inhaltsverzeichnis

• Verhaltenskodex
• Ich habe eine Frage
• Ich möchte mitwirken
• Fehler melden
• Verbesserungen vorschlagen
• Dein erster Code-Beitrag
• Die Dokumentation verbessern

Verhaltenskodex

Dieses Projekt und alle daran Beteiligten unterliegen dem MoeShare Verhaltenskodex. Durch deine Teilnahme wird von dir erwartet, diesen Kodex einzuhalten. Bitte melde unakzeptables Verhalten an .

Ich habe eine Frage

Wenn du eine Frage stellen möchtest, gehen wir davon aus, dass du die verfügbare Dokumentation gelesen hast.

Bevor du eine Frage stellst, ist es am besten, nach vorhandenen Problemen zu suchen, die dir möglicherweise helfen könnten. Falls du ein passendes Problem gefunden hast und immer noch Klarstellungen benötigst, kannst du deine Frage in diesem Problem stellen. Es ist auch ratsam, zuerst im Internet nach Antworten zu suchen.

Wenn du dann immer noch das Bedürfnis hast, eine Frage zu stellen und Klarstellungen benötigst, empfehlen wir folgendes:

• Eröffne ein Problem.
• Gib so viel Kontext wie möglich darüber an, worauf du stößt.
• Gib Projekt- und Plattformversionen an (Node.js, npm usw.), je nachdem, was relevant erscheint.

Wir kümmern uns dann so schnell wie möglich um das Problem.

Ich möchte mitwirken

Rechtlicher Hinweis

Wenn du zu diesem Projekt beiträgst, musst du zustimmen, dass du 100% des Inhalts erstellt hast, dass du die erforderlichen Rechte am Inhalt hast und dass der von dir beigetragene Inhalt unter der Projektlizenz bereitgestellt werden kann.

Fehler melden

Vor dem Einreichen eines Fehlerberichts

Ein guter Fehlerbericht sollte andere nicht dazu zwingen, dich nach weiteren Informationen zu fragen. Daher bitten wir dich, sorgfältig zu recherchieren, Informationen zu sammeln und das Problem in deinem Bericht ausführlich zu beschreiben. Bitte führe die folgenden Schritte im Voraus durch, um uns bei der Behebung eines potenziellen Fehlers so schnell wie möglich zu helfen.

• Stelle sicher, dass du die neueste Version verwendest.
• Ermittle, ob dein Fehler wirklich ein Fehler ist und kein Fehler auf deiner Seite, z. B. durch die Verwendung von inkompatiblen Umgebungskomponenten/Versionen (Stelle sicher, dass du die Dokumentation gelesen hast. Wenn du Unterstützung suchst, solltest du diesen Abschnitt überprüfen).
• Um zu sehen, ob andere Benutzer das gleiche Problem haben (und möglicherweise bereits gelöst haben), überprüfe, ob bereits ein Fehlerbericht für deinen Fehler oder Fehler im Fehler-Tracker vorhanden ist.
• Stelle sicher, dass du auch im Internet (einschließlich Stack Overflow) nachgeschaut hast, ob Benutzer außerhalb der GitHub-Community das Problem diskutiert haben.
• Sammle Informationen über den Fehler:
• Stack-Trace (Traceback)
• Betriebssystem, Plattform und Version (Windows, Linux, macOS, x86, ARM)
• Version des Interpreters, des Compilers, des SDK, der Laufzeitumgebung, des Paketmanagers, je nachdem, was relevant erscheint.
• Möglicherweise deine Eingabe und die Ausgabe
• Kannst du den Fehler zuverlässig reproduzieren? Und kannst du ihn auch mit älteren Versionen reproduzieren?

Wie reiche ich einen guten Fehlerbericht ein?

Du darfst niemals sicherheitsrelevante Probleme, Schwachstellen oder Fehler, die sensible Informationen enthalten, im Issue-Tracker oder an anderer Stelle öffentlich melden. Stattdessen müssen sicherheitsrelevante Fehler per E-Mail an gesendet werden.

Wir verwenden GitHub Issues, um Fehler und Fehler zu verfolgen. Wenn du auf ein Problem mit dem Projekt stößt:

• Eröffne ein Problem. (Da wir zu diesem Zeitpunkt noch nicht sicher sein können, ob es sich um einen Fehler handelt, bitten wir dich, noch nicht über einen Fehler zu sprechen und das Problem nicht zu kennzeichnen.)
• Erkläre das erwartete Verhalten und das tatsächliche Verhalten.
• Bitte gib so viele Informationen wie möglich an und beschreibe die Reproduktionsschritte, die jemand anderes befolgen kann, um das Problem selbst zu reproduzieren. Dies enthält normalerweise deinen Code. Für gute Fehlerberichte solltest du das Problem isolieren und einen reduzierten Testfall erstellen.
• Gib die Informationen an, die du im vorherigen Abschnitt gesammelt hast.

Sobald es eingereicht ist:

• Das Projektteam wird das Problem entsprechend kennzeichnen.
• Ein Teammitglied wird versuchen, das Problem mit den von dir bereitgestellten Schritten zu reproduzieren. Wenn es keine Reproduktionsschritte oder keine offensichtliche Möglichkeit gibt, das Problem zu reproduzieren, wird das Team dich nach diesen Schritten fragen und das Problem als needs-repro markieren. Fehler mit dem needs-repro-Tag werden nicht behandelt, bis sie reproduziert werden.
• Wenn das Team das Problem reproduzieren kann, wird es als needs-fix markiert, sowie möglicherweise andere Tags (wie critical), und das Problem wird jemandem zur Implementierung überlassen.

Verbesserungen vorschlagen

Dieser Abschnitt führt dich durch das Einreichen einer Verbesserungsidee für MoeShare, einschließlich völlig neuer Funktionen und kleiner Verbesserungen an vorhandener Funktionalität. Das Befolgen dieser Richtlinien wird den Betreuern und der Community helfen, deine Idee zu verstehen und verwandte Ideen zu finden.

Vor dem Einreichen einer Verbesserung

• Stelle sicher, dass du die neueste Version verwendest.
• Lies die Dokumentation sorgfältig durch und finde heraus, ob die Funktionalität bereits abgedeckt ist, vielleicht durch eine individuelle Konfiguration.
• Führe eine Suche durch, um zu sehen, ob die Verbesserung bereits vorgeschlagen wurde. Wenn dies der Fall ist, füge einen Kommentar zum vorhandenen Problem hinzu, anstatt ein neues zu erstellen.
• Finde heraus, ob deine Idee zum Umfang und den Zielen des Projekts passt. Es liegt an dir, ein starkes Argument vorzulegen, um die Entwickler des Projekts von den Vorteilen dieser Funktion zu überzeugen. Beachte, dass wir Funktionen möchten, die für die Mehrheit unserer Benutzer nützlich sind und nicht nur für eine kleine Teilmenge. Wenn du nur eine Minderheit von Benutzern ansprichst, solltest du in Erwägung ziehen, ein Add-On/Plugin-Bibliothek zu schreiben.

Wie reiche ich einen guten Vorschlag zur Verbesserung ein?

Vorschläge zur Verbesserung werden als GitHub-Probleme verfolgt.

• Verwende eine klare und beschreibende Überschrift für das Problem, um den Vorschlag zu identifizieren.
• Gib eine Schritt-für-Schritt-Beschreibung der vorgeschlagenen Verbesserung in so vielen Details wie möglich an.
• Beschreibe das aktuelle Verhalten und erkläre, welches Verhalten du stattdessen erwartet hast und warum. Zu diesem Zeitpunkt kannst du auch angeben, welche Alternativen für dich nicht funktionieren.
• Du kannst Screenshots und animierte GIFs hinzufügen, um die Schritte zu demonstrieren oder den Teil hervorzuheben, auf den sich der Vorschlag bezieht. Du kannst dieses Tool verwenden, um GIFs unter macOS und Windows aufzunehmen, sowie dieses Tool oder dieses Tool unter Linux.
• Erkläre, warum diese Verbesserung für die meisten MoeShare-Benutzer nützlich wäre. Du kannst auch auf andere Projekte hinweisen, die es besser gelöst haben und die als Inspiration dienen könnten.

Urheberschaft

Diese Anleitung basiert auf contributing-gen. Erstelle deine eigene!