Thông báo xác nhận
Thông báo cam kết rõ ràng giúp bạn dễ dàng xem xét các yêu cầu lấy dữ liệu hơn và tạo ghi chú phát hành dễ dàng hơn. Dự án Blockly sử dụng các thay đổi thông thường để giúp giải quyết vấn đề này.
Mỗi lệnh xác nhận phải có định dạng:
<type>: <description>
[optional body]
[optional footer(s)]
Lưu ý rằng kho lưu trữ Blockly cốt lõi có một công cụ tìm lỗi mã nguồn cam kết để giúp thực thi việc này. Nếu yêu cầu lấy dữ liệu của bạn có nhiều thay đổi, thì linter sẽ kiểm tra tiêu đề. Nếu có một cam kết duy nhất, ứng dụng sẽ kiểm tra cam kết đó. Tốt nhất là cả tiêu đề của yêu cầu lấy dữ liệu lẫn cá nhân bạn đều tuân thủ các nguyên tắc này.
Loại
Loại này không được để trống và tất cả đều là chữ thường. Sau đây là danh sách các loại được chấp nhận.
- việc nhà
- Đối với các cam kết hoàn thành các nhiệm vụ theo quy trình/tự động, chẳng hạn như nâng cấp phần phụ thuộc.
- không dùng nữa
- Đối với các thay đổi không dùng chức năng này nữa.
- feat
- Đối với các cam kết thêm chức năng mới vào Blockly.
- fix
- Đối với các cam kết sửa lỗi/lỗi trong Blockly.
- bản phát hành
- Đối với các thay đổi liên quan đến việc phát hành phiên bản mới.
Thay đổi có thể gây lỗi
Các cam kết thực hiện thay đổi có thể gây lỗi phải thêm ! sau loại cam kết. Thay đổi có thể gây lỗi là những thay đổi có thể khiến nhà phát triển ngừng sử dụng Blockly trong ứng dụng của họ, khiến họ phải làm thêm một số việc.
Ví dụ:
fix!: return type of workspace.paste
Thay đổi có thể gây lỗi có thể chứa bất kỳ loại hợp lệ nào nêu trên.
Nội dung mô tả
Phần mô tả không được để trống và phải có ít hơn 256 ký tự.
Nội dung
Phần nội dung là không bắt buộc. Nếu thuộc tính này được cung cấp, thì nên có một dòng trống giữa tham số và nội dung mô tả. Mã này phải được chia thành các dòng không quá 256 ký tự.
Lưu ý rằng thông thường, bạn nên đưa loại thông tin này vào phần mô tả yêu cầu lấy dữ liệu, bên cạnh/thay vì trực tiếp trong quy trình xác nhận.
Chân trang
Chân trang là không bắt buộc. Nếu tham số được cung cấp, thì sẽ có một dòng trống giữa tham số và phần nội dung. Tên này phải được chia thành các dòng không quá 256 ký tự.
Khắc phục các thay đổi không theo quy ước
Nếu không sử dụng các thay đổi thông thường khi sửa đổi, thì bạn sẽ có 2 lựa chọn để sửa thông báo, tuỳ thuộc vào số lượng thay đổi mà bạn có:
Nếu yêu cầu lấy dữ liệu của bạn có nhiều thay đổi, hãy chỉnh sửa tiêu đề của yêu cầu lấy dữ liệu cho phù hợp với các yêu cầu này. Khi yêu cầu lấy dữ liệu được hợp nhất, các thay đổi khác sẽ bị rút gọn để tiêu đề trở thành thông báo cam kết.
Nếu yêu cầu lấy dữ liệu của bạn có một cam kết duy nhất, hãy sửa đổi thông báo cam kết bằng cách sử dụng
git commit --amend, sau đó buộc đẩy các thay đổi vào nhánh phát triển của Blockly. Thao tác này sẽ tự động cập nhật mọi yêu cầu lấy dữ liệu đang mở liên kết với nhánh này.git push --force origin my-branch.