Đóng góp cho Đoạn nhạc

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

Những điều cần biết

Dưới đây là thông tin tổng quan nhanh về các thực tế về mẫu khối mà bạn cần biết để tạo PR.

  • Nhánh hoạt động là master và tất cả các PR phải được thực hiện với nhánh chính.
  • Chạy npm install ở cấp độ gốc của các mẫu dạng khối, chứ không phải ở cấp trình bổ trợ riêng lẻ. Khối mẫu 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 JavaScript của Google tuỳ thuộc vào ngôn ngữ bạn sử dụng.
  • Sử dụng các thay đổi thông thường trong thông báo cam kết và tiêu đề của yêu cầu lấy dữ liệu.

  • 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 mẫu theo khối để cài đặt các phần phụ thuộc.
  2. Chạy npm run start trong thư mục của trình bổ trợ để tạo và khởi động máy chủ chạy trang thử nghiệm 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ợ. Nếu muốn thêm một trình bổ trợ mới, bạn cần đặt trang này thành một trang thử nghiệm hữu ích để những người khác có thể xem chức năng của trình bổ trợ. Hãy xem trang playground để biết thêm thông tin.
  3. Thực hiện bất kỳ thay đổi cần thiết nào đối với mã của trình bổ trợ.
  4. Nếu bạn để máy chủ chạy, 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 trình bổ trợ hoạt động như dự kiến và không có lỗi hay 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 mã kiểm thử mocha tự động trong thư mục test/.
  7. Chạy npm run test để chạy kiểm thử tự động.
  8. Chạy npm run lint:fix để khắc phục lỗi tìm lỗi mã nguồn. 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 tất cả bài kiểm thử đều đạt, bạn đã sẵn sàng mở một PR trên bản chính với các thay đổi của mình.