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

รายงานปัญหา ดูซอร์สโค้ด รุ่น Nightly · 8.0 7.4 7.3 · 7.2 · 7.1 · 7.0 · 6.5

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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