Zu Samples beitragen

Blockly Samples enthält zusätzliche Inhalte zu Blockly, die nicht Teil des Haupt-Repositorys sind, darunter Plug-ins, Codelabs und Beispielcode. Weitere Informationen dazu finden Sie auf der Seite Repository-Struktur.

Wichtige Informationen

Hier finden Sie einen kurzen Überblick über Blockly-Beispiele, die Sie kennen müssen, um einen Pull-Request zu erstellen.

  • Der Arbeitszweig ist master und alle PRs sollten auf master basieren.
  • Führen Sie npm install auf der Stammebene von blockly-samples aus,nicht auf der Ebene des einzelnen Plug-ins. Blockly-samples ist ein Monorepo, d. h., es enthält mehrere Pakete im selben Repository. Die Installation auf Stammebene ist Teil des Workflows zur Verwaltung des Monorepos mit Lerna.
  • Der Code muss je nach verwendeter Sprache entweder dem JavaScript Style Guide oder dem TypeScript Style Guide von Google entsprechen.
  • Verwenden Sie konventionelle Commits in Ihren Commit-Nachrichten und Pull-Request-Titeln.

  • Alle neuen Codedateien müssen mit der Apache License 2.0 vorangestellt sein:

    /**
 *   @license
 *   Copyright <Current YYYY> Google LLC
 *   SPDX-License-Identifier: Apache-2.0
 */

Änderung vornehmen und prüfen

  1. Führen Sie npm install auf der Stammebene von blockly-samples aus, um Abhängigkeiten zu installieren.
  2. Führen Sie npm run start im Verzeichnis eines Plug-ins aus, um einen Server zu erstellen und zu starten, auf dem die Testseite des Plug-ins ausgeführt wird. Auf dieser Seite können Sie das Verhalten eines Plug-ins sehen. Wenn Sie ein neues Plug-in hinzufügen, müssen Sie diese Seite zu einer nützlichen Testseite machen, damit andere sehen können, was Ihr Plug-in tut. Weitere Informationen finden Sie auf der Seite playground.
  3. Nehmen Sie die erforderlichen Änderungen am Code des Plug-ins vor.
  4. Wenn Sie den Server laufen gelassen haben, werden Ihre Änderungen automatisch geladen. Andernfalls starten Sie den Server neu und prüfen Sie, ob das Plug-in wie erwartet funktioniert und in der Konsole keine Fehler oder Warnungen angezeigt werden.
  5. Führen Sie npm run build aus und prüfen Sie, ob keine Build-Fehler auftreten.
  6. Schreiben Sie automatisierte Mocha-Tests in das Verzeichnis test/.
  7. Führen Sie npm run test aus, um die automatisierten Tests auszuführen.
  8. Führen Sie npm run lint:fix aus, um Lint-Fehler zu beheben. Beheben Sie alle verbleibenden Warnungen oder Fehler.
  9. Führen Sie npm run format aus, um die automatische Formatierung auszuführen.
  10. Wenn alle Tests bestanden sind, können Sie einen Pull-Request mit Ihren Änderungen an master öffnen.