Đóng góp cho các mẫu

Mẫu Blockly chứa nội dung bổ sung liên quan đến Blockly không thuộc kho lưu trữ cốt lõi, bao gồm cả các trình bổ trợ, lớp học lập trình và mã mẫu. Để biết thêm thông tin chi tiết về từng loại, hãy xem trang Cấu trúc kho lưu trữ.

Điều cần biết

Sau đây là thông tin tổng quan nhanh về những điều bạn cần biết về blockly-samples để tạo một PR.

  • Nhánh đang hoạt động là main và tất cả các yêu cầu kéo (PR) đều phải được thực hiện đối với nhánh main.
  • Chạy npm install ở cấp gốc của blockly-samples chứ không phải ở cấp từng trình bổ trợ. Blockly-samples là một monorepo, tức là chứa nhiều gói trong cùng một kho lưu trữ và việc cài đặt ở cấp gốc là một phần của quy trình quản lý monorepo bằng Lerna.
  • Mã phải tuân thủ Hướng dẫn về kiểu JavaScript của Google hoặc Hướng dẫn về kiểu TypeScript tuỳ thuộc vào ngôn ngữ được sử dụng.
  • 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.

  • 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ấp gốc của blockly-samples để cài đặt các phần phụ thuộc.
  2. Chạy npm run start trong thư mục của một trình bổ trợ để tạo và khởi động một máy chủ đang chạy trang kiểm thử của trình bổ trợ. Bạn có thể sử dụng trang này để xem hành vi hiện có của một trình bổ trợ hoặc nếu đang thêm một trình bổ trợ mới, bạn sẽ cần biến trang này thành một trang kiểm thử hữu ích để người khác có thể xem trình bổ trợ của bạn làm gì. Hãy xem trang playground để biết thêm thông tin.
  3. Thực hiện mọi thay đổi cần thiết đối với mã của trình bổ trợ.
  4. Nếu bạn vẫn đang chạy máy chủ, các thay đổi của bạn sẽ tự động tải. Nếu không, hãy khởi động lại máy chủ và xác minh rằng trình bổ trợ hoạt động như mong đợi 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 các bài kiểm thử mocha tự động trong thư mục test/.
  7. Chạy npm run test để chạy các kiểm thử tự động.
  8. Chạy npm run lint:fix để khắc phục lỗi lint. Giải quyết mọi cảnh báo hoặc lỗi còn lại.
  9. Chạy npm run format để chạy trình định dạng tự động.
  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.