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