รายละเอียดคอมมิต
0/72 ตัวอักษร
ต้องระบุสรุป
อธิบายว่าอะไรและทำไม ไม่ใช่อย่างไร
ตัวอย่างสด
กรอกฟิลด์ที่จำเป็นเพื่อดูตัวอย่าง
กรอกรายละเอียดเพื่อสร้างข้อความคอมมิต...
เกี่ยวกับเครื่องมือนี้
ข้อกำหนด Conventional Commits เป็นแนวทางที่เบาสำหรับข้อความคอมมิต มันให้ชุดกฎที่ง่ายสำหรับการสร้างประวัติคอมมิตที่ชัดเจน ซึ่งทำให้การเขียนเครื่องมืออัตโนมัติง่ายขึ้น
รูปแบบข้อความคอมมิต
<type>(<scope>): <subject> <body> <footer>
ประโยชน์
- สร้าง CHANGELOG โดยอัตโนมัติ
- กำหนดการเพิ่มเวอร์ชันเชิงความหมายโดยอัตโนมัติ
- สื่อสารลักษณะของการเปลี่ยนแปลงให้กับเพื่อนร่วมทีมและผู้มีส่วนได้ส่วนเสีย
- เรียกใช้กระบวนการสร้างและเผยแพร่
- ทำให้ผู้คนสามารถมีส่วนร่วมได้ง่ายขึ้นโดยอนุญาตให้พวกเขาสำรวจประวัติคอมมิตที่มีโครงสร้างมากขึ้น
ประเภททั่วไป
✨
feat — A new feature
🐛
fix — A bug fix
📚
docs — Documentation only changes
💎
style — Code style changes (formatting, etc)
♻️
refactor — Code refactoring
✅
test — Adding or updating tests
การใช้ส่วนท้าย
ส่วนท้ายเป็นทางเลือกและประกอบด้วยข้อมูลเมตาเกี่ยวกับคอมมิต กรณีการใช้งานทั่วไป ได้แก่:
การเปลี่ยนแปลงที่ทำลาย: ใช้ BREAKING CHANGE: เพื่อระบุการเปลี่ยนแปลง API ที่เข้ากันไม่ได้ สิ่งนี้จะทำให้เกิดการเพิ่มเวอร์ชันหลักในการกำหนดเวอร์ชันเชิงความหมาย
BREAKING CHANGE: ปลายทาง API ต้องการการยืนยันตัวตนในขณะนี้ ผู้ใช้ต้องอัปเดตไคลเอนต์ API เพื่อรวมโทเค็นการยืนยันตัวตน
การอ้างอิงปัญหา: เชื่อมโยงคอมมิตกับตัวติดตามปัญหาโดยใช้คำหลักเช่น Closes, Fixes หรือ Resolves
Closes #123 Fixes #456, #789
ผู้เขียนร่วมและผู้ตรวจสอบ: ให้เครดิตผู้มีส่วนร่วมและผู้ตรวจสอบในคอมมิต
Co-authored-by: John Doe <john@example.com> Reviewed-by: Jane Smith <jane@example.com>