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