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

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 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 phần tử này, hãy xem trang Cấu trúc kho lưu trữ.

Thông tin cần biết

Dưới đây là thông tin tổng quan nhanh về các thông tin về blockly-samples mà bạn cần biết để tạo một yêu cầu thay đổi.

  • Nhánh làm việc là chính và tất cả các PR phải được thực hiện dựa trên chính.
  • Chạy npm install ở cấp gốc của blockly-samples, chứ không phải ở cấp trình bổ trợ riêng lẻ. Blockly-samples là một monorepo, có nghĩa là công cụ này 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ề quy tắc lập trình JavaScript hoặc Hướng dẫn về quy tắc định kiểu TypeScript của Google, tuỳ thuộc vào ngôn ngữ bạn sử dụng.
  • Sử dụng các cam kết thông thường trong thông báo xác nhận 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 blockly-samples để 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ột máy chủ 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 tại 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 cần phải 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 hoạt động như thế nào. 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 đã để 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 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 mã kiểm thử mocha tự động trong thư mục test/.
  7. Chạy npm run test để thực hiện các bài kiểm thử tự động.
  8. Chạy npm run lint:fix để sửa 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ả các bài kiểm thử đều thành công, bạn có thể mở một yêu cầu thay đổi đối với master bằng các thay đổi của mình.