Zum Kern beitragen

Das Blockly-Kern-Repository enthält den Code, der zum Ausführen einer beliebigen Blockly-basierten Anwendung erforderlich ist.

Wichtige Informationen

Hier finden Sie einen kurzen Überblick über die Fakten zu Blockly Core, die Sie für die Erstellung eines PR benötigen.

  • Der Arbeitszweig ist main und alle Pull-Anfragen sollten für „main“ gestellt werden.
  • Sie müssen die Pull-Request-Vorlage mit den erforderlichen Informationen ausfüllen.
  • Der Code muss dem TypeScript-Styleguide von Google entsprechen.
  • Verwenden Sie Conventional Commits in Ihren Commit-Nachrichten und Pull-Request-Titeln.
  • Nutzerorientierte Strings müssen in der Datei /msg/messages.js enthalten sein, damit sie übersetzt werden können. Weniger als 6% der Weltbevölkerung sprechen Englisch als Muttersprache.
  • Text in Blöcken sollte in der Regel nur Kleinbuchstaben enthalten (genau wie die Keywords in den meisten Programmiersprachen).
  • Abwärtskompatibilität beibehalten. Es gibt viele Blockly-Apps. Achten Sie darauf, dass Sie nicht alle anderen kaputt machen.

  • 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 aus, um Abhängigkeiten zu installieren.
  2. Führen Sie npm run start aus, um einen Server zu starten, auf dem die Playground-Umgebung ausgeführt wird. Auf dieser Seite können Sie das vorhandene Verhalten testen. Weitere Informationen finden Sie auf der Seite Playground.
  3. Nehmen Sie die erforderlichen Änderungen am Code vor.
  4. Wenn der Server noch läuft, aktualisieren Sie die Seite, um die Änderungen zu sehen. Andernfalls starten Sie den Server neu und prüfen Sie, ob sich der Code wie erwartet verhält und ob in der Konsole Fehler oder Warnungen angezeigt werden.
  5. Führen Sie npm run build aus und achten Sie darauf, dass keine Build-Fehler auftreten.
  6. Automatisierte Tests schreiben In der Regel handelt es sich dabei um Mocha-Tests im Verzeichnis tests/mocha. Wir können Sie aber auch um andere Arten von Tests bitten.
  7. Führen Sie npm run format aus, um den Code zu formatieren und einige Lint-Probleme automatisch zu beheben.
  8. Führen Sie npm test aus, um die automatisierten Tests auszuführen. Dadurch wird auch eslint ausgeführt.
  9. Wenn Lint-Fehler vorhanden sind, führen Sie npm run lint:fix aus, um die Probleme zu beheben, die automatisch behoben werden können. Beheben Sie alle verbleibenden Lint-Warnungen oder ‑Fehler.
  10. Wenn alle Tests bestanden wurden, können Sie mit Ihren Änderungen eine Pull-Anfrage für main erstellen.