Zu Core beitragen

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

Wichtige Informationen

Hier ist ein kurzer Überblick über die Fakten zu Blockly Core, die Sie zum Erstellen einer PR kennen müssen.

  • Der Working-Branch lautet develop und alle PRs sollten gegen "Develop" gerichtet werden.
  • Sie müssen die Pull-Anfragevorlage mit den angeforderten Informationen ausfüllen.
  • Der Code muss dem TypeScript Style Guide von Google entsprechen.
  • Verwenden Sie in Ihren Commit-Nachrichten und Pull-Anfragetiteln konventionelle Commits.
  • Für den Nutzer sichtbare Strings müssen in der Datei /msg/messages.js enthalten sein, damit sie übersetzt werden können. Weniger als 6% der Weltbevölkerung spricht Englisch muttersprachlich.
  • Text in Blöcken sollte in der Regel nur aus Kleinbuchstaben bestehen (wie die Schlüsselwörter in den meisten Programmiersprachen).
  • Wahrung der Abwärtskompatibilität. Es gibt zahlreiche Blockly-Apps. Machen Sie alle anderen nicht sprengen.

  • 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 aus, um Abhängigkeiten zu installieren.
  2. Führen Sie npm run start aus, um einen Server zu starten, auf dem der Playground ausgeführt wird. Sie können diese Seite verwenden, um das bestehende Verhalten zu testen. Weitere Informationen finden Sie auf der Seite playground.
  3. Nehmen Sie die erforderlichen Änderungen am Code vor.
  4. Ist der Server noch aktiv, 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 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. Automatisierte Tests schreiben In der Regel sind dies Mocha-Tests im Verzeichnis tests/mocha. Unter Umständen werden Sie aber auch nach anderen Arten von Tests gefragt.
  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 vorliegen, 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 PR-Kampagne gegen Develop starten.