Zu den Beispielen beitragen

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

Wichtige Informationen

Hier finden Sie einen kurzen Überblick über die Fakten zu blockly-samples, die Sie kennen müssen, um einen PR zu erstellen.

  • Der Arbeitszweig ist main und alle Pull-Anfragen sollten für „main“ gestellt werden.
  • Führen Sie npm install auf der Stammebene von blockly-samples aus und nicht auf der Ebene der einzelnen Plug-ins. Blockly-samples ist ein Monorepo, d. h., es enthält mehrere Pakete im selben Repository. Die Installation auf der Stammebene ist Teil des Workflows für die Verwaltung des Monorepos mit Lerna.
  • Der Code muss dem JavaScript Style Guide oder dem TypeScript Style Guide von Google entsprechen, je nachdem, welche Sprache verwendet wird.
  • Verwenden Sie Conventional Commits in Ihren Commit-Nachrichten und Pull-Request-Titeln.

  • Alle neuen Codedateien müssen mit der Apache-Lizenz 2.0 beginnen:

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

Änderung vornehmen und überprü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 vorhandene Verhalten eines Plug-ins sehen. Wenn Sie ein neues Plug-in hinzufügen, muss diese Seite ein nützliches Testbeispiel sein, damit andere sehen können, was Ihr Plug-in macht. Weitere Informationen finden Sie auf der Seite Playground.
  3. Nehmen Sie die erforderlichen Änderungen am Code des Plug-ins vor.
  4. Wenn der Server weiterhin ausgeführt wird, werden Ihre Änderungen automatisch geladen. Starten Sie den Server andernfalls neu und prüfen Sie, ob sich das Plug-in wie erwartet verhält und in der Konsole keine Fehler oder Warnungen angezeigt werden.
  5. Führen Sie npm run build aus und achten Sie darauf, dass keine Build-Fehler auftreten.
  6. Automatisierte Mocha-Tests im Verzeichnis test/ schreiben.
  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 den Autoformatter auszuführen.
  10. Wenn alle Tests bestanden wurden, können Sie mit Ihren Änderungen eine Pull-Anfrage für main erstellen.