คำขอแบบพุลเป็นเหมือนเลือดสาดชีวิตของที่เก็บ ช่วยให้ทุกอย่างแข็งแรงและเคลื่อนไหวได้ หน้านี้จะให้รายละเอียดเกี่ยวกับวิธีสร้างการประชาสัมพันธ์ที่ครบถ้วนและง่ายต่อการตรวจสอบ ซึ่งทำให้มีโอกาสมากขึ้นที่การประชาสัมพันธ์ของคุณจะถูกรวมเข้าด้วยกัน
ต่อไปนี้คือขั้นตอนที่คุณทำได้เพื่อให้มั่นใจว่าคุณสร้างการประชาสัมพันธ์ที่ดีที่สุดเท่าที่จะเป็นไปได้
สื่อสาร
ก่อนที่คุณจะเข้าร่วมและเริ่มเขียนโค้ด คุณควรติดต่อกับทีมหลักเพื่อให้พวกเขาทราบว่าคุณสนใจเรื่องใด
หากมีปัญหาที่สนใจ ให้แสดงความคิดเห็นในประเด็นนั้น โดยบอกว่าคุณจะเริ่มต้นแก้ไข เพื่อให้แน่ใจว่าเราไม่มีคน ทำงานอย่างเดียวกัน สมาชิกในทีมจะตอบกลับเพื่อยืนยันว่าเป็นคุณ
หากคุณมีไอเดียที่ไม่ครอบคลุมปัญหาใดๆ โปรดเขียนหนึ่งข้อก่อนที่จะเริ่มงาน ซึ่งทำให้ทีมมีโอกาสพูดคุยเกี่ยวกับวิธีที่ดีที่สุดในการสร้างการเปลี่ยนแปลงก่อนที่จะเริ่มสร้าง ซึ่งช่วยคุณประหยัดเวลาในการทำงานในระยะยาว
เตรียมตัว
หากนี่เป็นครั้งแรกที่คุณมีส่วนร่วมในบล็อก (Blockly) หรือกรณีตัวอย่างบล็อก ให้เริ่มต้นที่หน้าตั้งค่าการพัฒนา
ทำให้เล็ก
พยายามทำให้การเปลี่ยนแปลงมีขนาดเล็กและชัดเจนอยู่เสมอ เราจึงอยากตรวจสอบการประชาสัมพันธ์เล็กๆ น้อยๆ หลายรายการมากกว่า ให้ตรวจสอบการประชาสัมพันธ์ขนาดใหญ่เพียงรายเดียว กฎสำคัญบางประการมีดังนี้
- แก้ไขปัญหาเดียว อย่าพยายามจัดการกับหลายๆ ปัญหาพร้อมกัน
- จำกัดขอบเขต โดยปกติ PR จะใช้เวลาไม่เกิน 8 ชม. (ขึ้นอยู่กับ ความคุ้นเคยกับฐานของโค้ด)
- ใช้คอมมิต ถ้า PR ของคุณค่อนข้างใหญ่ ให้แบ่งการเปลี่ยนแปลงออกเป็นกลุ่มๆ อย่างสมเหตุสมผลโดยใช้ gitคอมมิต
รักษาความสะอาด
ทำไมจึงต้องสนใจสไตล์โค้ด เราจะใช้งานเป็นระยะเวลานาน และสไตล์ที่สอดคล้องกัน ทำให้การบำรุงรักษาง่ายขึ้น สไตล์หมายถึงการตั้งชื่อตัวแปร แต่ครอบคลุมวิธีจัดโครงสร้างโค้ด เขียนความคิดเห็น และอื่นๆ หากเป็นไปได้ เราจะใช้เครื่องมืออย่างeslint เพื่อตรวจสอบสไตล์โดยอัตโนมัติ
นอกจาก eslint แล้ว โปรดปฏิบัติตามคำแนะนำเหล่านี้:
- คู่มือสไตล์การแปลของ Google JavaScript
- คำแนะนำเกี่ยวกับข้อความคอมมิต
- หลักเกณฑ์การใช้ Blockly API
- คู่มือแนะนำเกี่ยวกับ Codelab
ทดสอบการเปลี่ยนแปลง
ก่อนที่จะจัดทำการประชาสัมพันธ์ คุณควรทดสอบอยู่เสมอว่าการเปลี่ยนแปลงของคุณใช้ได้ผล เพื่อที่จะได้ไม่ต้องกลับไปแก้ไขสิ่งต่างๆ ในภายหลัง ต่อไปนี้เป็นแนวคิดสำหรับ การทดสอบโครงการในหมวดหมู่ต่างๆ
- สำหรับปลั๊กอิน: เขียนการทดสอบมอคค่าอัตโนมัติเพื่อให้ครอบคลุมการเปลี่ยนแปลงของคุณ
- ตัวอย่าง: ทดสอบฟังก์ชันการทำงานที่แสดงทั้งหมดด้วยตนเอง
- สำหรับ Codelab: เรียกใช้บทแนะนำทั้งหมดในสภาพแวดล้อมที่สะอาดและทดสอบโค้ดตัวอย่างที่คุณให้
สื่อสาร
ส่วนนี้เป็นส่วนสุดท้ายที่โต้แย้งได้และมีความสำคัญมากที่สุดในการสร้างการประชาสัมพันธ์ ซึ่งก็คือการเขียนข้อมูลสรุป
การเขียนสรุปการประชาสัมพันธ์ที่ยอดเยี่ยมจะช่วยให้นักพัฒนาซอฟต์แวร์คนอื่นๆ ตรวจสอบการเปลี่ยนแปลงของคุณ ซึ่งทำให้มีโอกาสมากขึ้นที่การเปลี่ยนแปลงจะได้รับการยอมรับเร็วขึ้น
ข้อมูลสรุปควรมีข้อมูลดังต่อไปนี้
- ปัญหาที่เกี่ยวข้องกับการประชาสัมพันธ์ของคุณ
- สิ่งที่เปลี่ยนแปลงการประชาสัมพันธ์ของคุณ
- วิธีทดสอบการเปลี่ยนแปลง
- สิ่งใดก็ตามที่คุณต้องการให้ผู้ตรวจสอบพิจารณา
- ข้อมูลอื่นๆ ที่คุณคิดว่าผู้ตรวจสอบต้องการ
หากคุณทำตามเทมเพลต PR ตอนที่สร้างคำขอ คุณก็ควรจะเสร็จเรียบร้อย อย่าลืมว่าต้องกระชับและสมบูรณ์ที่สุด
ขอให้สนุกกับการเขียนโค้ด