วิศวกรรมซอฟต์แวร์
เตรียมการเปลี่ยนแปลงให้พร้อมตรวจโค้ด
คำขอเปลี่ยนแปลงเล็กและเข้าใจได้ พฤติกรรมตรวจแล้ว บริบทการตรวจ และความเสี่ยงที่รู้ทำให้ชัด
กระบวนการ
ทำตามลำดับนี้
- ทวนผลผู้ใช้หรือระบบที่ตั้งใจ และเทียบส่วนต่างกับขอบเขตนั้น
- ทบทวนทุกบรรทัดที่เปลี่ยนในบริบทไฟล์และระบบ เรื่องความเข้ากับการออกแบบ ความถูกต้อง ความปลอดภัย ความพร้อมกัน และความซับซ้อนที่เลี่ยงได้
- ตรวจว่าการทดสอบล้มเหลวได้เมื่อพฤติกรรมพัง ครอบคลุมกรณีขอบที่เกี่ยวข้อง และสมกับระดับความเสี่ยงของการเปลี่ยน
- รันการจัดรูปแบบ ลินต์ ตรวจชนิด การทดสอบ บิลด์ และการสร้างเอกสารที่ที่เก็บต้องมี
- ตัดการเปลี่ยนบังเอิญ เสียงที่สร้าง ข้อความดีบัก โค้ดตาย และความลับ แยกการเปลี่ยนหากทบทวนรวมกันไม่ได้
- เขียนสรุปคำขอรวมที่ครอบคลุมเหตุผล สิ่งที่เปลี่ยน หลักฐานตรวจ ภาพหน้าจอหรือโน้ตย้ายเมื่อเกี่ยวข้อง ความเสี่ยง และย้อนกลับ
เตรียมสิ่งนี้
ข้อมูลที่แมวจะขอ
- สาขาการเปลี่ยนหรือส่วนต่าง
- ประเด็นหรือเกณฑ์รับ
- คำสั่งร่วมสร้างและการทดสอบของที่เก็บ
เราเตอร์ + playbook เดียว
จัดเส้นทางก่อน เลือกอันเดียว
Cat Paw โหลด playbook เดียวต่องาน ไม่ผสมหลายอัน เริ่มที่เราเตอร์นี้ เส้นทางที่เหลือเป็นตัวเลือกเฉพาะ workflow
- เราเตอร์:
engineering-pack skills/engineering/mattpocock/code-review/SKILL.md
เส้นเขต
ขอบเขตเดินทางไปกับพรอมต์
- อย่าอ้างว่าการตรวจผ่านโดยไม่รันจริง
- อย่าเปิดข้อมูลรับรอง โทเคน หรือข้อมูลส่วนตัวในส่วนต่างหรือหลักฐาน
- ยกระดับด้านผู้เชี่ยวชาญ เช่น ความปลอดภัย ความเป็นส่วนตัว การเข้าถึง หรือความพร้อมกัน ไปยังผู้ทบทวนที่มีคุณสมบัติ
เสร็จหมายถึง
จุดจบที่ตรวจได้
ส่วนต่างมีขอบเขตและอธิบายได้ การตรวจท้องถิ่นที่ต้องมีผ่าน อาร์ติแฟกต์ทบทวนครบ และไม่มีการค้นพบทบทวนตนเองความรุนแรงสูงที่ยังไม่ปิด
แหล่งที่มา
กระบวนการนี้มาจากไหน
- google.github.io/eng-practices/review/reviewer/looking-for.html
- google.github.io/eng-practices/review/developer/small-cls.html
แหล่งที่มาตั้งรูปแบบของ workflow โพสต์ Reddit และชุมชน ถ้ามี ให้ถือเป็นเรื่องเล่าจากผู้ปฏิบัติ ไม่ใช่ข้อเท็จจริงสากล