กฎที่แนะนำ

เรามีรายการกฎที่แนะนำอยู่ในเอกสารประกอบ

ซึ่งเป็นชุดกฎคุณภาพสูงซึ่งจะให้ประสบการณ์ที่ดีแก่ผู้ใช้ของเรา เราจะแยกความแตกต่างระหว่างกฎที่รองรับและกฎหลายร้อยข้อที่คุณจะพบได้บนอินเทอร์เน็ต

ได้รับการเสนอชื่อ

หากชุดกฎเป็นไปตามข้อกำหนดด้านล่าง ผู้ดูแลกฎจะเสนอชุดกฎให้เป็นส่วนหนึ่งของกฎที่แนะนำได้โดยส่งปัญหาเกี่ยวกับ GitHub

หลังจากตรวจสอบโดยทีมหลัก Bazel ระบบจะแนะนำ รีวิวนี้ในเว็บไซต์ Bazel

ข้อกำหนดสำหรับผู้ดูแลกฎ

  • ชุดกฎมีฟีเจอร์สำคัญซึ่งเป็นประโยชน์ต่อผู้ใช้ Bazel จำนวนมาก (เช่น รองรับภาษาที่ได้รับความนิยมอย่างกว้างขวาง)
  • ชุดกฎได้รับการดูแลเป็นอย่างดี ต้องมีผู้ดูแลที่ใช้งานอยู่อย่างน้อย 2 ราย
  • ชุดกฎมีการจัดทำเป็นเอกสารไว้อย่างดี มีตัวอย่าง และใช้งานง่าย
  • ชุดกฎเป็นไปตามแนวทางปฏิบัติแนะนำและมีประสิทธิภาพ (ดูคู่มือประสิทธิภาพ)
  • ชุดกฎมีการครอบคลุมการทดสอบเพียงพอ
  • ชุดกฎได้รับการทดสอบบน BuildKite ด้วย Bazel เวอร์ชันล่าสุด การทดสอบควรผ่านเสมอ (เมื่อใช้เป็นการตรวจสอบที่ส่งล่วงหน้า)
  • นอกจากนี้ ชุดกฎยังได้รับการทดสอบกับการเปลี่ยนแปลงที่ใช้ร่วมกันไม่ได้ที่กำลังจะมาถึงด้วย คุณควรดำเนินการแก้ไข ความเสียหายภายใน 2 สัปดาห์ ควรรายงานปัญหาการย้ายข้อมูลไปยังทีม Bazel อย่างรวดเร็ว

ข้อกำหนดสำหรับนักพัฒนาซอฟต์แวร์ Bazel

  • กฎที่แนะนำจะได้รับการทดสอบเป็นประจำกับ Bazel ที่ศีรษะ (อย่างน้อยวันละครั้ง)
  • การเปลี่ยนแปลงใน Bazel อาจไม่เป็นไปตามกฎที่แนะนำ (ด้วยชุดแฟล็กเริ่มต้น) หากเป็นเช่นนั้น การเปลี่ยนแปลงนี้ควรได้รับการแก้ไขหรือย้อนกลับ

การลดระดับ

หากมีข้อกังวลว่าชุดกฎบางอย่างไม่เป็นไปตามข้อกำหนดอีกต่อไป ให้ยื่นปัญหาเกี่ยวกับ GitHub

ผู้ดูแลกฎจะได้รับการติดต่อและต้องตอบกลับภายใน 2 สัปดาห์ จากผลลัพธ์ที่ได้ ทีมหลักของ Bazel อาจตัดสินใจลดระดับกฎที่ตั้งไว้