ภาษาอังกฤษใน Code Review
ทำไม Code Review ถึงต้องใช้ภาษาอังกฤษพิเศษ
หัวข้อที่มีชื่อว่า “ทำไม Code Review ถึงต้องใช้ภาษาอังกฤษพิเศษ”Code review ไม่ใช่แค่การให้ข้อเสนอแนะทางเทคนิค — มันคือการสื่อสารในทีม การใช้ถ้อยคำที่ไม่เหมาะสมอาจ:
- ❌ ดูหยิ่งหรือเสียดสี
- ❌ ทำให้เพื่อนร่วมงานเสียขวัญ
- ❌ สร้างความเข้าใจผิด (โดยเฉพาะในทีมข้ามวัฒนธรรม)
ข่าวดีคือ: มีชุดสำนวนมาตรฐานที่ทุกคนเข้าใจ
10 สำนวนสำคัญใน Code Review
หัวข้อที่มีชื่อว่า “10 สำนวนสำคัญใน Code Review”1. Nit (ปัญหาเล็กน้อย)
หัวข้อที่มีชื่อว่า “1. Nit (ปัญหาเล็กน้อย)”“Nit” มาจาก “nitpick” แต่ใน code review เป็นคำในแง่บวก: “เล็กน้อย ไม่กระทบภาพรวม แต่ควรปรับปรุง”
❌ "This variable name is bad"✅ "Nit: could we rename this to `userCount`?"2. LGTM (Looks Good To Me)
หัวข้อที่มีชื่อว่า “2. LGTM (Looks Good To Me)”ตัวย่อที่แสดงว่าคุณตรวจแล้วและเห็นด้วยกับการ merge
3. Blocker (ปัญหาที่บล็อก)
หัวข้อที่มีชื่อว่า “3. Blocker (ปัญหาที่บล็อก)”ปัญหาสำคัญที่ต้องแก้ไขก่อน merge
Blocker: This will cause a race condition in `handleUserLogin`.4. Nice catch (จับได้ดี)
หัวข้อที่มีชื่อว่า “4. Nice catch (จับได้ดี)”เมื่อใครบางคนพบ bug หรือปัญหาที่ซ่อนอยู่
Nice catch! I didn't think about the edge case where `null` ...5. Have you considered (คุณได้พิจารณาไหม)
หัวข้อที่มีชื่อว่า “5. Have you considered (คุณได้พิจารณาไหม)”เสนอทางเลือกโดยไม่บังคับ
Have you considered using `useCallback` to prevent unnecessary re-renders?6. We should probably (เราควรจะ)
หัวข้อที่มีชื่อว่า “6. We should probably (เราควรจะ)”ข้อเสนอแนะอ่อนๆ ไม่จำเป็น แต่แนะนำ
We should probably add error handling here for the case where the API call fails.7. Ship it (ส่งออกเลย)
หัวข้อที่มีชื่อว่า “7. Ship it (ส่งออกเลย)”การเห็นด้วยแบบไม่เป็นทางการ: ดูแล้วไม่มีปัญหา deploy ได้เลย
Ship it! 🚀สูตรความสุภาพใน Code Review
หัวข้อที่มีชื่อว่า “สูตรความสุภาพใน Code Review”เมื่อชี้ปัญหา
หัวข้อที่มีชื่อว่า “เมื่อชี้ปัญหา”สูตร: บริบท → ปัญหา → ข้อเสนอแนะ
❌ "This code is inefficient"
✅ "In `processUserData`, iterating O(n²) might be slow with large datasets. Could we use a Set to get O(n) instead?"เมื่อไม่เห็นด้วย
หัวข้อที่มีชื่อว่า “เมื่อไม่เห็นด้วย”❌ "That's wrong"
✅ "I see your approach. One concern: `Math.random()` isn't cryptographically secure for auth tokens. Should we use `crypto.getRandomValues()`?"ข้อผิดพลาดทั่วไป
หัวข้อที่มีชื่อว่า “ข้อผิดพลาดทั่วไป”| สำนวนผิด | เหตุผล | เวอร์ชันที่ดีกว่า |
|---|---|---|
| ”This code is not good” | ตรงเกินไป ดูหยิ่ง | ”Could we refactor this for clarity?" |
| "You must change this” | ฟังดูเหมือนคำสั่ง | ”We should probably change this" |
| "This is wrong” | เจ็บปวด | ”This might cause X in scenario Y” |
ตารางอ้างอิงด่วน
หัวข้อที่มีชื่อว่า “ตารางอ้างอิงด่วน”| สถานการณ์ | สำนวน |
|---|---|
| เห็นด้วย + รายละเอียดเล็กน้อย | LGTM, just one nit: … |
| ไม่เห็นด้วยกับการตัดสินใจ | I see your approach, but have we considered…? |
| ปัญหาสำคัญ | Blocker: This will cause… |
| ข้อเสนอแนะเล็กน้อย | Nit: Could we…? |
| เห็นด้วยทั้งหมด | LGTM! Ship it. |