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

รายงานปัญหา ดูแหล่งที่มา /3} /4} {3/4} {3/4} {3/4} {3/4} /4.

ก่อนอื่นขอขอบคุณที่มีส่วนร่วมกับระบบนิเวศของ 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 ก็ควรดูตรงนี้ โดยใช้แบรนด์ของบุคคลที่สามเป็นข้อบ่งชี้
  • ฟาร์มสร้างของบาเซล: "ไร่สร้าง" คือฟาร์มคอมไพล์ ผู้ใช้จะเข้าใจว่าโปรเจ็กต์นี้เกี่ยวข้องกับการสร้างบนเซิร์ฟเวอร์

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

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

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