Zu Samples beitragen

Blockly Samples enthält zusätzliche Inhalte zu Blockly, die nicht zum Kern-Repository gehören, einschließlich Plug-ins, Codelabs und Beispielcode. Weitere Informationen zu den einzelnen Repositorys finden Sie auf der Seite Repository-Struktur.

Wichtige Informationen

Hier finden Sie eine kurze Übersicht über die Fakten zu Blockproben, die Sie zum Erstellen einer PR kennen müssen.

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

  • Allen neuen Codedateien muss das Präfix der Apache-Lizenz v2.0 vorangestellt werden:

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

Änderung vornehmen und bestätigen

  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. Sie können diese Seite verwenden, um das bestehende Verhalten eines Plug-ins zu sehen. Wenn Sie ein neues Plug-in hinzufügen, müssen Sie aus dieser Seite eine nützliche Testseite machen, damit andere sehen können, was Ihr Plug-in tut. Weitere Informationen finden Sie auf der Seite playground.
  3. Nehmen Sie alle erforderlichen Änderungen am Code des Plug-ins vor.
  4. Wenn der Server ausgeführt wird, werden Ihre Änderungen automatisch geladen. Starten Sie andernfalls den Server neu und prüfen Sie, ob das Plug-in wie erwartet funktioniert und keine Fehler oder Warnungen in der Console angezeigt werden.
  5. Führen Sie npm run build aus und achten Sie darauf, dass 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 das Autoformatter auszuführen.
  10. Wenn alle Tests bestanden wurden, können Sie mit Ihren Änderungen eine PR-Datei für den master erstellen.