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

ก่อนอื่น ขอขอบคุณที่มีส่วนร่วมในระบบนิเวศของ 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 migrator"

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

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

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

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

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

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