คุณพบจุดบกพร่องหรือมีแนวคิดเกี่ยวกับฟีเจอร์ใหม่เจ๋งๆ หรือไม่? การร่วมเขียนโค้ดเป็นวิธีที่ดีเยี่ยมในการมอบบางสิ่งกลับคืนสู่ชุมชนโอเพ่นซอร์ส ก่อนที่คุณจะเจาะลึกลงไปในโค้ด มีหลักเกณฑ์บางประการที่เราจำเป็นต้องให้ผู้ร่วมให้ข้อมูลปฏิบัติตาม เพื่อที่เราจะได้มีโอกาสรักษาเหนือสิ่งอื่นใด
ตรวจสอบให้แน่ใจว่าคุณมีบัญชี JIRA
ตรวจสอบให้แน่ใจว่าคุณมีบัญชี GitHub
หากคุณกำลังวางแผนที่จะใช้คุณสมบัติใหม่ คุณควรหารือเกี่ยวกับการเปลี่ยนแปลงของคุณในรายการผู้พัฒนาก่อน วิธีนี้ทำให้คุณมั่นใจได้ว่าจะไม่เสียเวลาไปกับสิ่งที่ไม่ถือว่าอยู่ในขอบเขตของ Apache Maven
ส่งตั๋วสำหรับปัญหาของคุณ โดยสมมติว่าไม่มีตั๋วอยู่แล้ว
อธิบายปัญหาอย่างชัดเจน รวมถึงขั้นตอนในการทำซ้ำเมื่อเป็นข้อบกพร่อง
ตรวจสอบให้แน่ใจว่าคุณกรอกเวอร์ชันแรกสุดที่คุณทราบว่ามีปัญหา
แยกพื้นที่เก็บข้อมูลบน GitHub
เรายอมรับคำขอดึงผ่าน GitHub รายชื่อผู้รับจดหมายของนักพัฒนาเป็นช่องทางหลักในการสื่อสารสำหรับผู้มีส่วนร่วม
มีแนวทางบางประการที่จะทำให้การสมัคร PR ง่ายขึ้นสำหรับเรา:
สร้างสาขาหัวข้อจากที่ที่คุณต้องการวางงานของคุณ (โดยปกติจะเป็นสาขาหลัก) พุชการเปลี่ยนแปลงของคุณไปยังสาขาหัวข้อในทางแยกของที่เก็บ
สร้างคอมมิตของหน่วยลอจิคัล
เคารพรูปแบบโค้ดต้นฉบับ: ด้วยการใช้รูปแบบโค้ดเดียวกัน แพตช์ควรเน้นเฉพาะความแตกต่างที่แท้จริงเท่านั้น โดยไม่ถูกรบกวนจากปัญหาการจัดรูปแบบใดๆ:
ใช้ช่องว่างสำหรับการเยื้องเท่านั้น
สร้างความแตกต่างน้อยที่สุด - ปิดการใช้งานในการบันทึก เช่น ฟอร์แมตซอร์สโค้ดใหม่ หรือจัดระเบียบการนำเข้า หากคุณรู้สึกว่าซอร์สโค้ดควรได้รับการฟอร์แมตใหม่ ให้สร้าง PR แยกต่างหากสำหรับการเปลี่ยนแปลงนี้
ตรวจสอบช่องว่างที่ไม่จำเป็นด้วย git diff --check
ก่อนดำเนินการ
ตรวจสอบให้แน่ใจว่าข้อความคอมมิตของคุณอยู่ในรูปแบบที่ถูกต้อง ข้อความคอมมิตของคุณควรมีคีย์ของปัญหา JIRA
[MSHARED-XXX] - Subject of the JIRA Ticket Optional supplemental description.
ตรวจสอบให้แน่ใจว่าคุณได้เพิ่มการทดสอบที่จำเป็น (JUnit/IT) สำหรับการเปลี่ยนแปลงของคุณ
รันการทดสอบทั้งหมดด้วย mvn -Prun-its verify
เพื่อให้แน่ใจว่าไม่มีอะไรเสียหายโดยไม่ตั้งใจ
ส่งคำขอดึงไปยังพื้นที่เก็บข้อมูลในองค์กร Apache
อัปเดตตั๋ว JIRA ของคุณและรวมลิงก์ไปยังคำขอดึงในตั๋ว
หากคุณวางแผนที่จะมีส่วนร่วมเป็นประจำ โปรดพิจารณายื่นข้อตกลงใบอนุญาตผู้ร่วมให้ข้อมูล
สำหรับการเปลี่ยนแปลงเล็กๆ น้อยๆ ในความคิดเห็นและเอกสารประกอบ ไม่จำเป็นต้องสร้างตั๋วใหม่ใน JIRA เสมอไป ในกรณีนี้ เป็นการเหมาะสมที่จะเริ่มบรรทัดแรกของการคอมมิตด้วย '(doc)' แทนหมายเลขตั๋ว
การมีส่วนสนับสนุนแพทช์
หน้าโครงการ Apache Maven Shared Components
ข้อตกลงใบอนุญาตผู้ร่วมให้ข้อมูล
เอกสาร GitHub ทั่วไป
เอกสารคำขอดึง GitHub
บัญชี Twitter ของ Apache Maven
#ช่อง Maven IRC บน freenode.org