Đóng góp cho phần lõi

Kho lưu trữ cốt lõi Blockly chứa mã cần thiết để chạy mọi ứng dụng dựa trên Blockly.

Điều cần biết

Sau đây là thông tin tổng quan ngắn gọn về những điều bạn cần biết về lõi Blockly để tạo một yêu cầu kéo.

  • Nhánh đang hoạt động là main và tất cả các yêu cầu kéo (PR) phải được thực hiện đối với main.
  • Bạn phải điền thông tin được yêu cầu vào mẫu yêu cầu kéo.
  • Mã phải tuân thủ Hướng dẫn về kiểu TypeScript của Google.
  • Sử dụng cam kết theo quy ước trong tiêu đề yêu cầu kéo và thông báo cam kết.
  • Các chuỗi mà người dùng thấy được phải nằm trong tệp /msg/messages.js để có thể được dịch. Chỉ có dưới 6% dân số thế giới nói tiếng Anh bản địa.
  • Văn bản trên các khối thường phải là chữ thường (giống như từ khoá trong hầu hết các ngôn ngữ lập trình).
  • Duy trì khả năng tương thích ngược. Có rất nhiều ứng dụng Blockly ngoài kia, đừng làm hỏng mọi thứ của người khác.

  • Mọi tệp mã mới đều phải có tiền tố là Giấy phép Apache phiên bản 2.0:

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

Thực hiện và xác minh thay đổi

  1. Chạy npm install để cài đặt các phần phụ thuộc.
  2. Chạy npm run start để khởi động một máy chủ chạy sân chơi. Bạn có thể sử dụng trang này để kiểm thử hành vi hiện có. Hãy xem trang sân chơi để biết thêm thông tin.
  3. Thực hiện mọi thay đổi cần thiết đối với mã.
  4. Nếu bạn đã để máy chủ chạy, hãy làm mới để xem các thay đổi. Nếu không, hãy khởi động lại máy chủ và xác minh rằng mã hoạt động như dự kiến và không có lỗi hoặc cảnh báo nào trong bảng điều khiển.
  5. Chạy npm run build và đảm bảo không có lỗi bản dựng.
  6. Viết bài kiểm thử tự động. Thông thường, đây sẽ là các kiểm thử mocha trong thư mục tests/mocha, nhưng chúng tôi có thể yêu cầu bạn cung cấp các loại kiểm thử khác.
  7. Chạy npm run format để định dạng mã và tự động khắc phục một số vấn đề về lint.
  8. Chạy npm test để chạy các kiểm thử tự động. Thao tác này cũng chạy eslint.
  9. Nếu có lỗi lint, hãy chạy npm run lint:fix để khắc phục những vấn đề có thể tự động khắc phục. Giải quyết mọi cảnh báo hoặc lỗi còn lại trong tìm lỗi mã nguồn.
  10. Nếu vượt qua tất cả các bài kiểm thử, bạn đã sẵn sàng mở một PR đối với main bằng các thay đổi của mình.