Commit Rule - Mrsmithz/Project-SW-Dev-and-Env GitHub Wiki

 เนื่องจากที่เวลาเราจะ Commit ต้องมีการเขียน Comment ใน Commit นั้นด้วยซึ่งหลายคนก็จะเขียนแบบไม่เป็นทางการ ทำให้คนอื่นที่ทำงานด้วยไม่เข้าใจว่าได้ทำอะไรเพิ่ม หรือแก้ไขอะไรไป เราจึงออกแบบ Pattern ในการ Commit ขึ้นมาทำให้ทุกคนเข้าใจแบบเดียวกัน

Pattern

• ใส่ Tag แล้วครอบด้วย [] ด้านหน้าแล้วต่อด้วย Description แล้วใส่ Note ใน () ไว้ด้านหลังเพื่อบอกสิ่งที่ต้องการจะบอกกับคนอื่น

Tag

• Tag : เป็นตัวบ่งบอกว่า Commit นี้ทำอะไรเป็นหลักตรงนี้เป็น Table

Tag List

• Create ใช้เมื่อทำการ Commit อะไรใหม่ๆ ลงใน Github เช่น Page, Feature, API
• Update ใช้เมื่อทำการแก้ไขบางอย่างที่เคยได้สร้างไว้
• Fix Bug ใช้เมื่อทำการแก้ Bug ที่เกิดขึ้น
• Delete ใช้เมื่อทำการลบสิ่งที่เคยสร้างไว้
• Structure ใช้เมื่อทำการแก้ Structure ภายในงานเช่นย้าย File ไปไว้ที่ Directory อื่น
• Etc ใช้เมื่อ Commit อะไรก็ตามที่ไม่ตรงกับ Tag อื่นๆด้านบน

Description

• Description : ไว้ใช้อธิบายว่าได้ทำการ Commit อะไรมา โดยอธิบายแบบย่อๆ ให้เข้าใจได้

Note

• Note: จะทำการใส่หรือว่าไม่ใส่ก็ได้ โดยจะเอาไว้บอกคนอื่นว่า ต้องการอะไรหรือเกิดปัญหาอะไรขึ้นในการ Commit ครั้งนี้

Example

• [Create] Create Home Page
• [Update] Add Navbar in Home Page (Need notification API in notification button)
• [Fix Bug] Fix create post API bug on validate function
• [Delete] Delete icon that not use in Icon directory
• [Structure] Edit structure in page directory
• [Etc] Add new node module (Call npm install!!)