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