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

Nightly · 9.1 · 9.0 · 8.7 · 8.6 · 8.5 · 8.4 · 8.3 · 8.2 · 8.1

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

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

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

ดูการติดตั้งใช้งานกฎ Starlark ใหม่ ในเอกสาร

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

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

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

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

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

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

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

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

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

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

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

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

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

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