[Doc] ขั้นตอนการ Pull request To main

กรณีทีมข้างนอก Project จะทำงานด้วย ทีมข้างนอกจะทำการ Fork งานออกไปทำ เมื่อทีมข้างนอกทำงานเสร็จ จะต้องทำการเอางานที่ทำกลับเข้า Project หลัก โดยจะทำการ Pull request เข้ามา

ขั้นตอนการ Pull request To main ก็จะมี 4 ขั้นตอน คือ

1. ขั้นตอนการสร้าง Pull request
2. ขั้นตอนการ Code review
3. ทำการเลือกสถานะให้กับ Pull request ที่ขอมา
4. ยืนยันการเอา Code เข้า Project หลัก

ขั้นตอนการสร้าง Pull requests

1. เข้ามาที่เมนู Repo เลือกเมนู Pull requests แล้วกด Create a pull request ตามกรอบสีแดงดังภาพที่ 1

ภาพที่ 1 ขั้นตอนการสร้าง pull requests

2. ทำการกรอกข้อมูล Title, รายละเอียด, เพิ่มคนที่จะมาตรวจ Code, issue ที่ทำงานด้วย ตามกรอบสีส้ม แล้วกด Create ตามกรอบสีแดงดังภาพที่ 2

ภาพที่ 2 การยืนยันการสร้าง pull requests

ขั้นตอนการ Code review

เมื่อมีทีมข้างนอกมีการขอ Pull request เข้ามาผู้ดูแล Project จะต้องทำการตรวจ Code ที่ขอ Pull request เข้ามา เพื่อดูว่า Code ที่ขอ Pull request จะนำเข้า Project หลักได้หรือไม่

ถ้าผู้ดูแล Project ทำการ review code เสร็จ ก็จะสามารถเพิ่ม Comment อาจจะเพิ่มเพื่อบอกเป็นนัยๆ ว่ารับเรื่องแล้วนะ โดย Comment จะมีสถานะ 5 สถานะ ดังนี้

1. สถานะ Active เป็นการบอกให้ผู้ที่ขอ Pull-request รับรู้ว่ารับเรื่องแล้ว เดียวทางผู้ดูแลกำลังจะทำการ review code ให้

ภาพที่ 9 การแสดงความคิดเห็นและเลือกสถานะ Active

2. สถานะ Pending ในกรณีที่กำลังรอดำเนินการอะไรบ้างอย่างอยู่

ภาพที่ 10 การแสดงความคิดเห็นและเลือกสถานะ Pending

3. สถานะ Resolved ในกรณีที่ได้รับการแก้ปัญหาอะไรบางอย่างเรียบร้อยแล้ว

ภาพที่ 11 การแสดงความคิดเห็นและเลือกสถานะ Resolved

4. สถานะ Won’t fix ในกรณีที่แก้ปัญหานั้นไม่ได้ ไม่ว่ากรณีใดก็ตาม

ภาพที่ 12 การแสดงความคิดเห็นและเลือกสถานะ Won’t fix

5. สถานะ Close เป็นการบอกว่ายอมรับ code ที่เขียนเข้ามา และปิดงานสำหรับการแสดงความคิดเห็นนั้นๆ

ภาพที่ 13 การแสดงความคิดเห็นและเลือกสถานะ Close

*** ในกรณีที่มีการโต้ตอบแสดงความคิดเห็นใน Comment ผู้ที่มีส่วนเกี่ยวข้องกับ การขอ Pull request สามารถมาดูว่ามี Comment ที่เพิ่มมาใหม่หรือเปล่าได้ที่รายการ Pull request ตรงกรอบสีแดงดังภาพที่ 14

ภาพที่ 14 วิธีเช็ค Comment ของการขอ Pull-request

ทำการเลือกสถานะให้กับ Pull request ที่ขอมา

เมื่อผู้ดูแล Project ทำการตรวจ Code ที่ขอ Pull request เข้ามาและผ่านการทำ Code review เรียบร้อยแล้ว ผู้ดูแล Project จะทำการเลือกสถานะให้กับ Pull request ที่ขอมา โดยสถานะจะมี 4 สถานะ

1. ผู้ดูแล Project จะทำการเลือกสถานะ Approve

ผู้ดูแล project ทำการตรวจ code ที่ขอ Pull request แล้ว Code ที่ขอ Pull request เข้ามาสามารถทำงานได้ ไม่มีปัญหาอะไร

ภาพที่ 3 การขอ Pull request ที่เป็นสถานะ Approve

2. ผู้ดูแล Project จะทำการเลือกสถานะ Approve to suggestions
ผู้ดูแล project ทำการตรวจ code ที่ขอ Pull request แล้ว Code ที่ขอ Pull request เข้ามามีข้อแนะนำ แต่ Code สามารถทำงานได้

ภาพที่ 4 การขอ Pull request ที่เป็นสถานะ Approve to suggestion

3. ผู้ดูแล Project จะทำการเลือกสถานะ Wait for author

ผู้ดูแล project ทำการตรวจ code ที่ขอ Pull request แล้ว Code ที่ขอ Pull request เข้ามาอาจจะต้องปรับแก้ Code ต่อเวลาให้ไปปรับแก้ไข Code

ภาพที่ 5 การขอ Pull request ที่เป็นสถานะ Wait for author

4. ผู้ดูแล Project จะทำการเลือกสถานะ Reject

ผู้ดูแล project ทำการตรวจ code ที่ขอ Pull request แล้ว Code ที่ขอ Pull request เข้ามาไม่ต้องที่จะเอา Code เข้า Project หลัก

ภาพที่ 6 การขอ Pull request ที่เป็นสถานะ Reject

ยืนยันการเอา Code เข้า Project หลัก

เมื่อผู้ดูแล Project ใส่สถานะที่ขอ Pull request เข้ามาเสร็จแล้ว ก็จะทำการยืนยัน

1. เลือกสถานะ “complete” เพื่อยืนยันที่ “จะเอา Code นี้เข้า Project หลัก”

ภาพที่ 7 การเลือกสถานะ Complete เพื่อยืนยันที่จะเอา Code นี้เข้า Project หลัก

2. เลือกสถานะ “Abandon ”เพื่อยืนยันที่ “จะไม่เอา Code นี้เข้า Project หลัก”

ภาพที่ 8 การเลือกสถานะ Abandon เพื่อยืนยันที่จะไม่เอา Code นี้เข้า Project หลัก