<aside> 💡 เทมเพลตนี้บันทึกวิธีการตรวจสอบโค้ด มีประโยชน์สำหรับพนักงานใหม่และพนักงานทางไกลเพื่อให้เข้าใจและทำงานสอดคล้องกัน

</aside>

ปรัชญา

ทำไมคุณถึงทำการตรวจสอบโค้ด? หลักการนำทางของคุณสำหรับการตรวจสอบเหล่านี้คืออะไร?

คุณอาจต้องการกล่าวถึงหน้าอื่น ๆ ที่นี่ เช่น แนวทางด้านวิศวกรรม ในการเชื่อมโยงไปยังหน้าอื่นในเนื้อหาเดียวกัน ให้พิมพ์@ตามด้วยชื่อของหน้า:แนวทางการวิศวกรรม

การเตรียมโค้ดสำหรับการตรวจสอบ

การเตรียมการช่วยให้ผู้ตรวจสอบของคุณประสบความสำเร็จ

ข้อความการส่งมอบ

ตรวจสอบให้แน่ใจว่าข้อความการคอมมิตของคุณมีความชัดเจนและให้ข้อมูล

คำอธิบาย PR ของ Github

คำอธิบาย PR ของคุณควรเป็นส่วนขยายของข้อความ commit ของคุณ เขียนเกี่ยวกับทั้งสิ่งที่ commit เปลี่ยนแปลง และวิธีที่คุณนำไปใช้

การดำเนินการตรวจสอบโค้ด

วิธีการตรวจสอบ

• หาก PR มีปริมาณมาก ให้ทำสองรอบ
  • ในการอ่านครั้งแรก ให้ทำความเข้าใจการเปลี่ยนแปลงโค้ดในระดับภาพรวม
  • ในการอ่านครั้งที่สอง ให้ใส่ใจกับรายละเอียดเชิงความหมายมากขึ้น

ตัวอย่าง

var commentCount = 0;

คุณอาจแนะนำให้ใช้letแทนvar