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

รายงานปัญหา ดูแหล่งที่มา Nightly · 8.4 · 8.3 · 8.2 · 8.1 · 8.0 · 7.6

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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