Zum Kern beitragen

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

Wichtige Informationen

Hier finden Sie einen kurzen Überblick über Blockly Core, die Sie kennen müssen, um eine PR zu erstellen.

  • Der Arbeitszweig ist develop und alle PRs sollten auf develop basieren.
  • Sie müssen die Pull-Anfragevorlage mit den angeforderten Informationen ausfüllen.
  • Der Code muss dem TypeScript-Stilhandbuch von Google entsprechen.
  • Verwenden Sie konventionelle Commits in Ihren Commit-Nachrichten und Pull-Request-Titeln.
  • Nutzersichtbare Strings müssen sich in der /msg/messages.js-Datei befinden, damit sie übersetzt werden können. Weniger als 6% der Weltbevölkerung sprechen Englisch als Muttersprache.
  • Der Text in Blöcken sollte im Allgemeinen in Kleinbuchstaben geschrieben sein, genau wie die Keywords in den meisten Programmiersprachen.
  • Abwärtskompatibilität beibehalten Es gibt viele Blockly-Apps. Bitte stört die anderen nicht.

  • Alle neuen Codedateien müssen mit der Apache-Lizenz 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 aus, um Abhängigkeiten zu installieren.
  2. Führen Sie npm run start aus, um einen Server mit dem Playground zu starten. Auf dieser Seite können Sie das aktuelle Verhalten testen. Weitere Informationen finden Sie auf der Playground-Seite.
  3. Nehmen Sie die erforderlichen Änderungen am Code vor.
  4. Wenn Sie den Server laufen lassen haben, aktualisieren Sie die Seite, um die Änderungen zu sehen. Andernfalls starten Sie den Server neu und prüfen Sie, ob der Code 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. Automatisierte Tests schreiben In der Regel handelt es sich dabei um Mocha-Tests im Verzeichnis tests/mocha. Möglicherweise werden Sie aber auch um andere Arten von Tests gebeten.
  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 auftreten, führen Sie npm run lint:fix aus, um die automatisch behebbaren Probleme zu beheben. Beheben Sie alle verbleibenden Lint-Warnungen oder -Fehler.
  10. Wenn alle Tests bestanden wurden, können Sie einen PR mit Ihren Änderungen für develop öffnen.