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