Codierungsstarterprojekte
Ein grundlegendes Repository, um Ihre Starterprojekte mit anderen zu teilen und ihnen zu helfen, auch zu wachsen!
Zunächst einmal danke, dass Sie sich die Zeit genommen haben, um einen Beitrag zu leisten!
Alle Arten von Beiträgen werden gefördert und geschätzt. In dem Inhaltsverzeichnis finden Sie verschiedene Möglichkeiten, um zu helfen und Details darüber, wie dieses Projekt mit ihnen umgeht. Bitte lesen Sie den entsprechenden Abschnitt vor, bevor Sie Ihren Beitrag leisten. Es wird es uns für US -amüsierende Erzieher erheblich erleichtern und die Erfahrung für alle Beteiligten glätten. Die Community freut sich auf Ihre Beiträge.
Und wenn Sie das Projekt mögen, aber einfach keine Zeit haben, um einen Beitrag zu leisten, ist das in Ordnung. Es gibt andere einfache Möglichkeiten, das Projekt zu unterstützen und Ihre Wertschätzung zu zeigen, über die wir uns auch sehr freuen würden:
- Spiele das Projekt
- Tweet darüber
- Verweisen Sie dieses Projekt in der Readme Ihres Projekts
- Erwähnen Sie das Projekt bei örtlichen Meetups und erzählen Sie Ihren Freunden/Kollegen
Inhaltsverzeichnis
- Verhaltenskodex
- Ich habe eine Frage
- Ich möchte einen Beitrag leisten
- Meldung von Fehler
- Verbesserungen vorschlagen
Verhaltenskodex
Dieses Projekt und alle, die daran teilnehmen, unterliegt dem Verhaltenskodex für den Beitrag.md. Durch die Teilnahme wird erwartet, dass Sie diesen Code aufrechterhalten. Bitte melden Sie ein inakzeptables Verhalten in <>.
Ich habe eine Frage
Wenn Sie eine Frage stellen möchten, gehen wir davon aus, dass Sie die verfügbare Dokumentation gelesen haben.
Bevor Sie eine Frage stellen, suchen Sie am besten nach vorhandenen Problemen, die Ihnen helfen könnten. Falls Sie ein geeignetes Problem gefunden haben und dennoch geklärt werden müssen, können Sie Ihre Frage in diesem Problem schreiben. Es ist auch ratsam, im Internet nach Antworten zu suchen.
Wenn Sie dann immer noch das Gefühl haben, eine Frage zu stellen und zu klären, empfehlen wir Folgendes:
- Ein Problem öffnen.
- Geben Sie so viel Kontext wie möglich über das, was Sie begehen.
- Stellen Sie Projekt- und Plattformversionen (NodeJS, NPM usw.) an, je nachdem, was relevant erscheint.
Wir werden uns dann so schnell wie möglich um das Problem kümmern.
Ich möchte einen Beitrag leisten
Rechtliche Bekanntmachung
Wenn Sie zu diesem Projekt beitragen, müssen Sie zustimmen, dass Sie 100% des Inhalts verfasst haben, dass Sie über die erforderlichen Rechte an den Inhalten verfügen und dass der Inhalt, den Sie beitragen, im Rahmen der Projektlizenz bereitgestellt werden können.
Meldung von Fehler
Vor dem Einreichen eines Fehlerberichts
Ein guter Fehlerbericht sollte nicht dazu führen, dass andere Sie für weitere Informationen verfolgen müssen. Aus diesem Grund bitten wir Sie, sorgfältig zu untersuchen, Informationen zu sammeln und das Problem in Ihrem Bericht ausführlich zu beschreiben. Bitte führen Sie die folgenden Schritte im Voraus aus, um potenzielle Fehler so schnell wie möglich zu beheben.
- Stellen Sie sicher, dass Sie die neueste Version verwenden.
- Stellen Sie fest, ob Ihr Fehler wirklich ein Fehler und kein Fehler auf Ihrer Seite ist, z.
- Um festzustellen, ob andere Benutzer das gleiche Problem erlebt (und möglicherweise bereits gelöst) haben, prüfen Sie, ob noch kein Fehlerbericht für Ihren Fehler oder Ihren Fehler im Fehler -Tracker vorhanden ist.
- Stellen Sie außerdem sicher, dass Sie das Internet (einschließlich Stack -Überlauf) durchsuchen, um festzustellen, ob Benutzer außerhalb der Github -Community das Problem besprochen haben.
- Sammeln Sie Informationen über den Fehler:
- Stack Trace (Traceback)
- Betriebssystem, Plattform und Version (Windows, Linux, MacOS, x86, Arm)
- Version des Dolmetschers, Compiler, SDK, Laufzeitumgebung, Paketmanager, je nachdem, was relevant erscheint.
- Möglicherweise Ihre Eingabe und die Ausgabe
- Können Sie das Problem zuverlässig reproduzieren? Und können Sie es auch mit älteren Versionen reproduzieren?
Wie sende ich einen guten Fehlerbericht?
Sie dürfen niemals sicherheitsbezogene Probleme, Schwachstellen oder Fehler melden, einschließlich sensibler Informationen zum Problem Tracker oder anderswo in der Öffentlichkeit. Stattdessen müssen sensible Fehler per E -Mail an <> gesendet werden.
Wir verwenden GitHub -Probleme, um Fehler und Fehler zu verfolgen. Wenn Sie mit dem Projekt auf ein Problem stoßen:
- Ein Problem öffnen. (Da wir an diesem Punkt nicht sicher sein können, ob es sich um einen Fehler handelt oder nicht, bitten wir Sie, noch nicht über einen Fehler zu sprechen und das Problem nicht zu kennzeichnen.)
- Erklären Sie das Verhalten, das Sie erwarten würden, und das tatsächliche Verhalten.
- Bitte geben Sie so viel Kontext wie möglich an und beschreiben Sie die Fortpflanzungsschritte , die jemand anderes ausführen kann, um das Problem selbst nachzubilden. Dies enthält normalerweise Ihren Code. Für gute Fehlerberichte sollten Sie das Problem isolieren und einen reduzierten Testfall erstellen.
- Geben Sie die Informationen an, die Sie im vorherigen Abschnitt gesammelt haben.
Sobald es eingereicht wurde:
- Das Projektteam wird das Problem entsprechend bezeichnen.
- Ein Teammitglied wird versuchen, das Problem mit Ihren bereitgestellten Schritten zu reproduzieren. Wenn es keine Reproduktionsschritte oder keine offensichtliche Möglichkeit gibt, das Problem zu reproduzieren, wird das Team Sie nach diesen Schritten bitten und das Problem als
needs-repro markieren. Fehler mit dem needs-repro Tag werden erst angegangen, wenn sie reproduziert werden. - Wenn das Team in der Lage ist, das Problem zu reproduzieren, wird es
needs-fix und möglicherweise andere Tags (z. B. critical ) und das Problem wird von jemandem implementiert.
Verbesserungen vorschlagen
Dieser Abschnitt führt Sie durch die Einreichung eines Verbesserungsvorschlags für den Beitrag.md, einschließlich vollständig neuer Funktionen und geringfügigen Verbesserungen der vorhandenen Funktionalität . Das Befolgen dieser Richtlinien hilft den Betreuern und der Community dabei, Ihren Vorschlag zu verstehen und verwandte Vorschläge zu finden.
Vor der Einreichung einer Verbesserung
- Stellen Sie sicher, dass Sie die neueste Version verwenden.
- Lesen Sie die Dokumentation sorgfältig durch und finden Sie heraus, ob die Funktionalität bereits durch eine individuelle Konfiguration behandelt wird.
- Führen Sie eine Suche durch, um festzustellen, ob die Verbesserung bereits vorgeschlagen wurde. Wenn dies der Fall ist, fügen Sie dem vorhandenen Problem einen Kommentar hinzu, anstatt eine neue zu eröffnen.
- Finden Sie heraus, ob Ihre Idee zum Umfang und den Zielen des Projekts passt. Es liegt an Ihnen, einen starken Fall zu machen, um die Entwickler des Projekts von den Vorzügen dieser Funktion zu überzeugen. Denken Sie daran, dass wir Funktionen wünschen, die für die Mehrheit unserer Benutzer und nicht nur für eine kleine Teilmenge nützlich sein werden. Wenn Sie nur auf eine Minderheit von Benutzern abzielen, sollten Sie eine Add-On/Plugin-Bibliothek schreiben.
Wie kann ich einen guten Verbesserungsvorschlag eingeben?
Verbesserungsvorschläge werden als GitHub -Probleme verfolgt.
- Verwenden Sie einen klaren und beschreibenden Titel für das Problem, um den Vorschlag zu identifizieren.
- Geben Sie eine Schritt-für-Schritt-Beschreibung der vorgeschlagenen Verbesserung in so vielen Details wie möglich an.
- Beschreiben Sie das aktuelle Verhalten und erklären Sie, welches Verhalten Sie stattdessen erwartet haben und warum. Zu diesem Zeitpunkt können Sie auch erkennen, welche Alternativen nicht für Sie funktionieren.
- Möglicherweise möchten Sie Screenshots und animierte GIFs einbeziehen , die Ihnen helfen, die Schritte zu demonstrieren oder auf den Teil hinzuweisen, mit dem der Vorschlag zusammenhängt. Sie können dieses Tool verwenden, um GIFs auf MacOS und Windows sowie dieses Tool oder dieses Tool unter Linux aufzunehmen.
- Erklären Sie, warum diese Verbesserung für die meisten zu beitragen.md -Benutzern nützlich wäre . Möglicherweise möchten Sie auch auf die anderen Projekte hinweisen, die sie besser gelöst haben und die als Inspiration dienen könnten.
