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