ข้อความคอมมิต
ข้อความคอมมิตที่ชัดเจนจะช่วยให้ตรวจสอบคำขอพุลได้ง่ายขึ้น และสร้างหมายเหตุประจำรุ่นได้ง่ายขึ้น โปรเจ็กต์ Blockly ใช้ข้อความคอมมิตแบบมาตรฐานเพื่อช่วยในเรื่องนี้
โดยแต่ละคอมมิตควรมีรูปแบบดังนี้
<type>: <description>
[optional body]
[optional footer(s)]
โปรดทราบว่าที่เก็บหลักของ Blockly มีโปรแกรมตรวจสอบโค้ดที่คอมมิตเพื่อช่วยบังคับใช้ หากคำขอ ดึงมีหลายคอมมิต Linter จะตรวจสอบชื่อ หากมีคอมมิตเดียว ระบบจะตรวจสอบคอมมิตนั้น ทั้งนี้ควรให้ทั้งคอมมิตแต่ละรายการและชื่อคำขอพุลเป็นไปตามหลักเกณฑ์เหล่านี้
ประเภท
ประเภทต้องไม่ว่างเปล่าและเป็นตัวพิมพ์เล็กทั้งหมด รายการประเภทที่ยอมรับมีดังนี้
chore- สำหรับการคอมมิตที่ทำงานประจำ/อัตโนมัติให้เสร็จสมบูรณ์ เช่น การอัปเกรด การอ้างอิง
deprecate- สำหรับการคอมมิตที่เลิกใช้งานฟังก์ชันการทำงาน
feat- สำหรับการคอมมิตที่เพิ่มฟังก์ชันใหม่ลงใน Blockly
fix- สำหรับการคอมมิตที่แก้ไขข้อบกพร่อง/ข้อผิดพลาดใน Blockly
release- สำหรับการคอมมิตที่เกี่ยวข้องกับการเผยแพร่เวอร์ชันใหม่
การเปลี่ยนแปลงที่ส่งผลกับส่วนอื่นในระบบ
การคอมมิตที่ทำให้เกิดการเปลี่ยนแปลงที่ทำให้ใช้งานร่วมกันไม่ได้ควรต่อท้ายด้วย ! หลังประเภทของ
การคอมมิต การเปลี่ยนแปลงที่ทำให้เกิดข้อขัดข้องคือการเปลี่ยนแปลงที่อาจทำให้เกิดข้อขัดข้องสำหรับนักพัฒนาแอปที่ใช้ Blockly ใน
แอปของตน ซึ่งทำให้ต้องทำงานเพิ่มเติม
ตัวอย่างเช่น
none
fix!: return type of workspace.paste
การเปลี่ยนแปลงที่ไม่รองรับอาจมีประเภทที่ถูกต้องตามที่ระบุไว้ข้างต้น
คำอธิบาย
คำอธิบายต้องไม่ว่างเปล่าและมีความยาวไม่เกิน 256 อักขระ
เนื้อความ
โดยคุณจะระบุเนื้อหาหรือไม่ก็ได้ หากระบุไว้ ควรมีบรรทัดว่างระหว่างชื่อกับคำอธิบาย โดยต้องแบ่งเป็นบรรทัดที่มีอักขระไม่เกิน 256 ตัว
โปรดทราบว่าโดยปกติแล้ว เราขอแนะนำให้ใส่ข้อมูลประเภทนี้ใน คำอธิบายคำขอพุล นอกเหนือจาก/แทนที่จะใส่ในคอมมิตโดยตรง
ส่วนท้าย
โดยคุณจะใช้ส่วนท้ายหรือไม่ใช้ก็ได้ หากระบุไว้ ควรมีบรรทัดว่างระหว่าง ข้อความนี้กับเนื้อหา โดยต้องแบ่งเป็นบรรทัดที่มีอักขระไม่เกิน 256 ตัว
การแก้ไขการคอมมิตที่ไม่เป็นไปตามรูปแบบ
หากไม่ได้ใช้ข้อความคอมมิตแบบเดิมเมื่อทำการ แก้ไข คุณจะมี 2 ตัวเลือกในการแก้ไขข้อความโดยขึ้นอยู่กับจำนวนคอมมิตที่คุณมี ดังนี้
หากคำขอ Pull มีหลายรายการ ให้แก้ไขชื่อคำขอ Pull ให้ เป็นไปตามข้อกำหนด เมื่อผสานคำขอ Pull แล้ว ระบบจะย่อ คอมมิตอื่นๆ เพื่อให้ชื่อกลายเป็นข้อความคอมมิต
หากคำขอ Pull มีคอมมิตเดียว ให้แก้ไขข้อความคอมมิตโดยใช้
git commit --amendจากนั้นบังคับพุชการเปลี่ยนแปลงไปยัง Fork ของ Blockly การดำเนินการนี้จะอัปเดตคำขอพุลที่เปิดอยู่ทั้งหมดซึ่งเชื่อมโยงกับ สาขานี้โดยอัตโนมัติgit push --force origin my-branch.