การมีส่วนร่วม
ขอขอบคุณสำหรับความสนใจในการร่วมพัฒนาโครงการ Rand!
เรายินดีต้อนรับผู้มีส่วนร่วมทุกคน แต่โปรดเข้าใจว่าทีมงานของเรามีทรัพยากรและเวลาจำกัด มักมีงานส่วนอื่นในโครงการที่กำลังดำเนินอยู่ และแม้กระทั่งการพิจารณารับ Pull Request (PR) ที่สมบูรณ์แล้วก็ยังต้องใช้เวลาค่อนข้างมาก (ทั้งการรีวิวโค้ดและการดูแลรักษาต่อเนื่องในระยะยาว) ดังนั้นเราอาจใช้เวลาพอสมควรในการตอบกลับคุณ
การมีส่วนร่วมทุกประเภท
-
ขอบเขต: โปรดพิจารณาว่า “ปัญหา” ที่คุณพบนั้นอยู่ในขอบเขตเดิมของโครงการหรือเป็นการขอเพิ่มความสามารถใหม่ ทั้งนี้ การมองว่าสิ่งใดเป็น ข้อบกพร่อง หรือไม่นั้นอาจขึ้นอยู่กับมุมมองของแต่ละบุคคล เราอาจจำเป็นต้องปฏิเสธข้อเสนอเพื่อหลีกเลี่ยงภาระงานที่เกินกำลัง
หากคุณต้องการขยายขอบเขตของโครงการ (เช่น การรองรับแพลตฟอร์มใหม่ หรือการเพิ่มชุดทดสอบบน CI) โปรดเตรียมพร้อมที่จะช่วยดูแลรักษาในส่วนนั้นอย่างต่อเนื่องในระยะยาว
-
การแก้ไขปัญหา: หากเป็นปัญหาที่คุณสามารถแก้ไขได้ด้วยตนเองได้ง่าย โปรดพิจารณาเปิดเป็น Pull Request แทนการเปิด Issue แต่หากเป็นปัญหาที่แก้ไขได้ยาก หรือดูเหมือนอาจขัดแย้งกับงานส่วนอื่นที่กำลังดำเนินการอยู่ ก็อย่าลังเลที่จะเปิดเป็น Issue เข้ามา
พูลรีเควสต์
-
บันทึกการเปลี่ยนแปลง: ยกเว้นในกรณีที่เป็นการเปลี่ยนแปลงเพียงเล็กน้อย โปรดเพิ่มบันทึกไว้ใน
CHANGELOG.mdของแต่ละเครตที่ได้รับผลกระทบ โดยใส่ไว้ใต้หัวข้อ[Unreleased]ด้านบนสุด (เพิ่มหัวข้อนี้หากยังไม่มี) พร้อมระบุหมายเลข PR ด้วย (ซึ่งหมายความว่าต้องเพิ่มบันทึกนี้ หลังจาก เปิด PR แล้ว) -
คอมมิต: หากเป็นการเปลี่ยนแปลงขนาดใหญ่ โปรดพิจารณาแบ่งออกเป็นหลายๆ คอมมิตย่อย โดยพยายามให้แต่ละคอมมิตสามารถคอมไพล์ผ่านได้เสมอ การทำ rebase คอมมิตอาจเป็นประโยชน์เมื่อมีการปรับปรุงโค้ดอย่างมีนัยสำคัญ
-
เอกสารประกอบ: เรากำหนดให้ทุกไอเท็มที่เป็นสาธารณะ (public items) ต้องมีเอกสารกำกับอย่างครบถ้วน พร้อมตัวอย่างโค้ดสั้นๆ ในจุดที่เหมาะสม
-
ความสามารถในการดูแลรักษา: สิ่งสำคัญยิ่งสำหรับเราคือ โค้ดต้องอ่านและเข้าใจง่าย ไม่ซับซ้อนเกินไปจนตรวจสอบความถูกต้องได้ยาก
-
ประสิทธิภาพ: เรามุ่งเน้นประสิทธิภาพที่ดีเสมอ และในบางครั้งก็ยอมลงแรงเพิ่มอย่างมากเพื่อให้ได้ประสิทธิภาพสูงสุด อย่างไรก็ตาม เราต้องคำนึงถึงความสามารถในการดูแลรักษาโค้ดควบคู่กันไปด้วย โดยต้องชั่งน้ำหนักว่าประสิทธิภาพที่เพิ่มขึ้นเพียงเล็กน้อยคุ้มค่ากับความซับซ้อนของโค้ดที่เพิ่มขึ้นหรือไม่ ใช้การวัดประสิทธิภาพ
-
รูปแบบโค้ด: จัดรูปแบบโค้ดให้เรียบร้อยสวยงาม โดยทั่วไป ควรจำกัดความยาวแต่ละบรรทัดไว้ที่ไม่เกิน 80 ตัวอักษร
-
Unsafe: ใช้เฉพาะเมื่อมีความจำเป็นจริงๆ เท่านั้น และหลีกเลี่ยงหากมีทางเลือกอื่นที่ดีกว่า โปรดตรวจสอบให้แน่ใจว่าโค้ด
unsafeนั้นสามารถตรวจสอบความถูกต้องได้อย่างชัดเจน -
สัญญาอนุญาตและการระบุที่มา: โครงการนี้เผยแพร่ภายใต้สัญญาอนุญาตแบบเสรีตามเงื่อนไขของ MIT และ Apache Public Licence v2 เราถือว่าการมีส่วนร่วมทั้งหมดอยู่ภายใต้ข้อกำหนดของสัญญาอนุญาตเหล่านี้ ทั้งนี้ ลิขสิทธิ์ยังคงเป็นของผู้มีส่วนร่วมแต่ละท่าน
ผลงานทั้งหมดจะระบุที่มาว่า “The Rand Project Developers” ซึ่งไม่ใช่ entity ทางกฎหมายอย่างเป็นทางการ แต่หมายถึงกลุ่มผู้มีส่วนร่วมทั้งหมดในโครงการนี้ ดูรายละเอียดเพิ่มเติมได้ในไฟล์
COPYRIGHT -
ขอบคุณ!