ตั้งชื่อโปรเจ็กต์ที่เกี่ยวข้องกับ Bazel

วันที่ รายงานปัญหา ดูแหล่งที่มา ตอนกลางคืน · 7.3 · 7.2 · 7.1 · 7.0 · 6.5

ก่อนอื่นขอขอบคุณที่มีส่วนร่วมกับระบบนิเวศของ Bazel โปรดติดต่อ ชุมชน Bazel รายชื่ออีเมลของ bazel-discuss เพื่อแชร์โปรเจ็กต์และชื่อที่แนะนำ

หากคุณกำลังสร้างเครื่องมือที่เกี่ยวกับ Bazel หรือแชร์กฎของ Skylark เราขอแนะนำให้ทำตามหลักเกณฑ์ต่อไปนี้สำหรับชื่อโปรเจ็กต์

การตั้งชื่อกฎของ Starlark

ดูการทำให้กฎ Starlark ใหม่ใช้งานได้ ไว้ในเอกสาร

ส่วนนี้จะมีผลกับคุณกําลังสร้างเครื่องมือเพื่อเสริมสร้างระบบนิเวศของ Bazel เช่น ปลั๊กอิน IDE ใหม่ หรือผู้ย้ายระบบบิลด์ใหม่

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

ทำตามหลักเกณฑ์ต่อไปนี้ในการตั้งชื่อเครื่องมือ Bazel

  1. ขอไม่แนะนำชื่อแบรนด์ใหม่: "Bazel" เป็นแบรนด์ใหม่อยู่แล้ว ไม่ควรทำให้ผู้ใช้สับสนด้วยชื่อใหม่มากเกินไป

  2. แนะนำการใช้ชื่อที่มีคำว่า "Bazel" เพราะจะช่วยให้มั่นใจได้ว่า เป็นเครื่องมือที่เกี่ยวข้องกับ Bazel และช่วยให้ผู้คนค้นพบเครื่องมือนี้ด้วยเครื่องมือค้นหา

  3. ต้องการใช้ชื่อที่สื่อความหมายเกี่ยวกับการทำงานของเครื่องมือ ดังนี้ ตามหลักแล้ว ชื่อไม่ควรจำเป็นต้องมีคำบรรยายเพื่อให้ผู้ใช้ได้รับสินค้าครั้งแรก ทายว่าเครื่องมือนี้ทำอะไร การใช้คำภาษาอังกฤษที่คั่นด้วยการเว้นวรรคก็เป็นสิ่งที่ดี ในการบรรลุเป้าหมายนี้

  4. ไม่จำเป็นต้องใช้ธีมดอกไม้หรืออาหาร: Bazel ชอบ ใบโหระพา ต้นไม้ คุณไม่จำเป็นต้อง มองหาชื่อที่เป็นพืช อาหาร หรือที่เกี่ยวข้องกับ "ใบโหระพา"

  5. หากเครื่องมือของคุณเกี่ยวข้องกับแบรนด์ของบุคคลที่สามอื่น ให้ใช้เฉพาะ ข้อบ่งชี้: เช่น ใช้ "Bazel migrator for Cmake" แทนที่จะเป็น "ผู้ย้ายถิ่นฐาน Cmake Bazel"

หลักเกณฑ์เหล่านี้มีผลกับ URL ของที่เก็บ GitHub ด้วย กำลังอ่านที่เก็บ URL ควรช่วยให้ผู้คนเข้าใจว่าเครื่องมือนี้ทำอะไรได้บ้าง แน่นอนที่สุดว่าที่เก็บ ชื่อสามารถสั้นลงและต้องใช้ขีดกลางแทนการเว้นวรรคและอักษรตัวพิมพ์เล็ก

ตัวอย่างของชื่อที่ดี:

  • Bazel for Eclipse: ผู้ใช้จะเข้าใจว่าหากต้องการใช้ Bazel ด้วย Eclipse นี่คือตำแหน่งที่ผู้ชมควรดู ใช้แบรนด์ของบุคคลที่สาม เป็นข้อบ่งชี้
  • โรงงานสร้างของบาเซล: "ไร่สร้าง" เป็น Compile Farm ผู้ใช้ จะเข้าใจว่าโปรเจ็กต์นี้เกี่ยวข้องกับการสร้างบนเซิร์ฟเวอร์

ตัวอย่างชื่อที่ควรหลีกเลี่ยงมีดังนี้

  • Ocimum: ชื่อวิทยาศาสตร์ของใบโหระพา ไม่เกี่ยวข้องกับโครงการ Bazel อย่างเพียงพอ
  • Bazelizer: เครื่องมือเบื้องหลังชื่อนี้อาจทำสิ่งต่างๆ ได้มากมาย ไม่สื่อความหมายมากพอ

โปรดทราบว่าคำแนะนำเหล่านี้สอดคล้องกับ หลักเกณฑ์ Google ใช้เมื่อการทำให้โปรเจ็กต์เป็นแบบโอเพนซอร์ส