Zu SubQuery beitragen

Herzlich Willkommen und vielen Dank, dass Sie in Erwägung ziehen, zu diesem SubQuery-Projekt beizutragen! Gemeinsam können wir den Weg in eine dezentralere Zukunft ebnen.

Hinweis Diese Dokumentation wird vom SubQuery-Team aktiv gepflegt. Wir freuen uns über Ihre Beiträge. Sie können dies tun, indem Sie unser GitHub-Projekt verzweigen und Änderungen an allen Dokumentations-Markdown-Dateien im Verzeichnis `docs` vornehmen. :::

Was folgt, ist eine Reihe von Richtlinien (keine Regeln) für das Mitwirken an SubQuery. Die Befolgung dieser Richtlinien hilft uns dabei, den Beitragsprozess für alle Beteiligten einfach und effektiv zu gestalten. Es teilt auch mit, dass Sie sich bereit erklären, die Zeit der Entwickler zu respektieren, die dieses Projekt verwalten und entwickeln. Im Gegenzug werden wir diesen Respekt erwidern, indem wir Ihr Problem angehen, Änderungen in Betracht ziehen, an Verbesserungen mitarbeiten und Ihnen helfen, Ihre Pull-Anfragen abzuschließen.

Code of Conduct

Wir nehmen unsere Open-Source-Community-Projekte und Verantwortung ernst und halten uns und andere Mitwirkende an hohe Kommunikationsstandards. Durch Ihre Teilnahme und Ihren Beitrag zu diesem Projekt stimmen Sie zu, unseren Verhaltenskodexopen in new window einzuhalten.

Erste Schritte

Beiträge zu unseren Repositories erfolgen über Issues und Pull Requests (PRs). Einige allgemeine Richtlinien, die beides abdecken:

  • Suchen Sie nach bestehenden Problemen und PRs, bevor Sie Ihre eigenen erstellen.
  • Wir arbeiten hart daran, sicherzustellen, dass Probleme umgehend behoben werden, aber je nach Auswirkung kann es eine Weile dauern, die Ursache zu untersuchen. Eine freundliche @-Erwähnung im Kommentarthread an den Einreicher oder einen Beitragenden kann helfen, Aufmerksamkeit zu erregen, wenn Ihr Problem blockiert.

Wie man einen Beitrag leistet

Fehler melden

Fehler werden als GitHub-Probleme verfolgt. Wenn Sie ein Problem protokollieren, erklären Sie das Problem und fügen Sie zusätzliche Details hinzu, um den Betreuern zu helfen, das Problem zu reproduzieren:

  • Verwenden Sie einen klaren und beschreibenden Titel für das Problem, um das Problem zu identifizieren.
  • Beschreiben Sie die genauen Schritte, um das Problem zu reproduzieren.
  • Beschreiben Sie das Verhalten, das Sie beobachtet haben, nachdem Sie die Schritte ausgeführt haben.
  • Erklären Sie, welches Verhalten Sie stattdessen erwartet haben und warum.
  • Fügen Sie wenn möglich Screenshots hinzu.

Senden von Pull-Requests

Im Allgemeinen folgen wir dem „Fork-and-Pull“-Git-Workflow:

  • Verzweigen Sie das Repository zu Ihrem eigenen Github-Konto.
  • Klonen Sie das Projekt auf Ihren Computer.
  • Erstellen Sie lokal einen Zweig mit einem prägnanten, aber aussagekräftigen Namen.
  • Übernehmen Sie Änderungen an der Verzweigung.
  • Befolgen Sie alle Formatierungs- und Testrichtlinien, die für dieses Repo spezifisch sind.
  • Pushen Sie Änderungen an Ihren Fork.
  • Öffnen Sie eine PR in unserem Repository.

Kodierungskonventionen

Git-Commit-Nachrichten

  • Verwenden Sie die Gegenwartsform ("Add feature" not "Added feature").
  • Verwenden Sie den Imperativ ("Move cursor to..." not "Moves cursor to...").
  • Beschränken Sie die erste Zeile auf 72 Zeichen oder weniger.

JavaScript-Styleguide

  • Der gesamte JavaScript-Code ist mit Prettier und ESLint versehen.