การตั้งชื่อโครงการที่เกี่ยวข้องกับ Bazel

รายงานปัญหา ดูแหล่งที่มา

ก่อนอื่น ขอขอบคุณที่ร่วมสร้างระบบนิเวศของ Bazel โปรดติดต่อชุมชน Bazel ในรายชื่ออีเมลของการสนทนาถึง คุณจะใช้ Bazel เพื่อแชร์โครงการและชื่อที่แนะนํา

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

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

โปรดดูหัวข้อการทําให้กฎ Starlark ใหม่ใช้งานได้ในเอกสาร

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

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

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

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

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

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

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

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

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

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

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

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

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

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