Đọc thêm về trình bổ trợ
Quy trình
Các trình bổ trợ sẽ trải qua 4 giai đoạn: đề xuất, thảo luận, triển khai và phát hành.
Đề xuất
Trình bổ trợ sẽ bắt đầu ở dạng đề xuất. Bạn có thể đề xuất trình bổ trợ bằng cách tạo một vấn đề mới với mẫu Feature Request (Yêu cầu tính năng).
Đọc thêm về cách viết yêu cầu về tính năng
Ngoài thông tin về yêu cầu tính năng cơ bản, trình bổ trợ đề xuất nên bao gồm:
- API mà trình bổ trợ sẽ hiển thị.
- Các API cần được thêm vào hoặc thay đổi trong Blockly cốt lõi để hỗ trợ trình bổ trợ.
- Ảnh chụp màn hình, ảnh GIF hoặc bản mô phỏng nếu trình bổ trợ có các tính năng giao diện người dùng.
- Nội dung giải thích lý do bạn nên sử dụng trình bổ trợ của bên thứ nhất thay vì trình bổ trợ của bên thứ ba.
Nhóm Blockly sẽ xem xét các đề xuất khi có vấn đề và đóng vấn đề hoặc thêm nhãn trạng thái: thảo luận.
Thảo luận
Tiếp theo, một trình bổ trợ sẽ chuyển sang giai đoạn thảo luận. Giai đoạn này bao gồm:
- Làm rõ chức năng mong muốn.
- Thông tin làm rõ API của trình bổ trợ.
- Lập kế hoạch thực hiện.
- Lập kế hoạch kiểm thử.
- Thảo luận về các thay đổi về API trong Blockly cốt lõi.
- Chia các trình bổ trợ lớn thành các bước triển khai.
- Việc đặt tên trình bổ trợ, dựa trên quy ước đặt tên của chúng tôi.
- Việc xác nhận tất cả tiêu chí của bên thứ nhất sẽ được đáp ứng.
Cuộc thảo luận này thường diễn ra về vấn đề trên GitHub. Phạm vi của trình bổ trợ càng nhỏ, giai đoạn thảo luận càng nhanh có thể diễn ra. Các trình bổ trợ lớn hơn có thể thu hút sự chú ý của cộng đồng và những ý kiến mạnh mẽ về Giải pháp phù hợp. Nếu điều này xảy ra với vấn đề của bạn, thì xin chúc mừng! Bạn đã tìm thấy một nội dung mà mọi người quan tâm.
Mục tiêu là vào cuối giai đoạn thảo luận, tất cả các quyết định thiết kế chính đã được đưa ra và có danh sách rõ ràng các bước triển khai. Bạn phải ghi lại cả hai phần trong các nhận xét về vấn đề đó.
Trong quá trình thảo luận, chúng ta có thể quyết định nên sử dụng trình bổ trợ bên thứ ba và không phát hành trình bổ trợ trong phạm vi @blockly. Trong trường hợp đó, chúng tôi sẽ giải thích
lý do và đóng vấn đề.
Khi cuộc thảo luận hoàn tất, một thành viên trong nhóm Blockly sẽ thêm nhãn status: implementation (trạng thái: triển khai) vào vấn đề.
Triển khai
Các bước triển khai bao gồm:
- Chạy
npx @blockly/create-packageđể thiết lập trình bổ trợ và thư mục của trình bổ trợ đó qua một mẫu. Tìm hiểu thêm... - Triển khai logic cốt lõi cho trình bổ trợ.
- Triển khai giao diện người dùng, nếu cần.
- Thử nghiệm trình bổ trợ bằng mocha.
- Ghi lại trình bổ trợ, bao gồm
README.
Nếu vấn đề của trình bổ trợ có nhãn status: implementation (trạng thái: triển khai), thì trạng thái đó đã sẵn sàng để triển khai hoặc đang được triển khai. Để tránh lặp lại các nỗ lực, bất kỳ ai quan tâm nên nhận xét về vấn đề này và hỏi xem vấn đề có còn nhận đóng góp hay không.
Nhiều người đóng góp có thể triển khai song song. Bạn có thể cộng tác triển khai một trình bổ trợ trên nhánh phát triển của riêng mình hoặc thông qua yêu cầu kéo đối với kho lưu trữ này. Nếu bạn muốn cộng tác trên một trình bổ trợ trong kho lưu trữ này, hãy yêu cầu nhóm Blockly tạo một nhánh tính năng cho bạn.
Bạn nên thêm trình bổ trợ vào tệp gh-pages/index.md trong nhánh master của mẫu khối. Điều này sẽ khiến các trình bổ trợ này xuất hiện
trên trang web Trình bổ trợ của chúng tôi. Các trình bổ trợ của bên thứ nhất phải trỏ đến trang thử nghiệm của các trình bổ trợ đó. Bạn cũng có thể thêm các trình bổ trợ của bên thứ ba vào trang này và có thể trỏ đến một đường liên kết do chủ sở hữu chọn, chẳng hạn như bản minh hoạ được lưu trữ hoặc trang npm.
Xuất bản
Cuối cùng là phát hành. Nhóm Blockly sử dụng Lerna để quản lý việc tạo phiên bản và phát hành cho tất cả các trình bổ trợ.
Thứ Năm hằng tuần, mọi trình bổ trợ đã thay đổi kể từ bản phát hành gần đây nhất sẽ được phát hành. Nếu bạn cần phát hành một thay đổi sớm hơn, vui lòng ghi chú thay đổi đó trong yêu cầu lấy dữ liệu của bạn.
Trang web Trình bổ trợ cũng được cập nhật bất cứ khi nào trình bổ trợ được phát hành.
Các trình bổ trợ chưa sẵn sàng phát hành phải được đánh dấu là private trong package.json. Điều này có thể xảy ra nếu một trình bổ trợ dựa vào một thay đổi chưa được xuất bản trong core Blockly. Core Blockly được xuất bản vào tuần cuối cùng của mỗi quý (ba tháng một lần).