Trước tiên, cảm ơn bạn đã đóng góp cho hệ sinh thái Bazel! Vui lòng liên hệ với cộng đồng Bazel trên danh sách gửi thư để thảo luận về bazel để chia sẻ dự án của bạn và tên dự án được đề xuất.
Nếu đang tạo một công cụ liên quan đến Bazel hoặc chia sẻ các quy tắc Skylark, bạn nên làm theo các nguyên tắc sau cho tên dự án:
Đặt tên cho quy tắc Starlark
Xem phần Triển khai các quy tắc Starlark mới trong tài liệu.
Đặt tên cho các công cụ khác có liên quan đến Bazel
Phần này áp dụng nếu bạn đang xây dựng một công cụ giúp làm phong phú hệ sinh thái Bazel. Ví dụ: trình bổ trợ IDE mới hoặc trình di chuyển hệ thống xây dựng mới.
Không dễ để chọn được một tên phù hợp cho công cụ của bạn. Nếu chúng ta không cẩn thận và sử dụng quá nhiều tên mã, thì hệ sinh thái Bazel có thể trở nên rất khó hiểu đối với người mới chơi.
Làm theo các nguyên tắc sau để đặt tên cho các công cụ Bazel:
Không muốn giới thiệu tên thương hiệu mới: "Bazel" đã là một thương hiệu mới cho người dùng, chúng ta nên tránh nhầm lẫn họ với quá nhiều tên mới.
Ưu tiên sử dụng tên có chứa "Bazel": Cách này giúp thể hiện rằng đó là một công cụ có liên quan đến Bazel, đồng thời giúp mọi người tìm thấy công cụ này bằng công cụ tìm kiếm.
Ưu tiên sử dụng tên mô tả về hoạt động của công cụ: Tốt nhất là tên không cần tiêu đề để người dùng có thể hình dung rõ ràng hoạt động của công cụ. Việc sử dụng các từ tiếng Anh được phân tách bằng dấu cách là một cách hiệu quả để làm được điều này.
Không bắt buộc phải sử dụng chủ đề hoa hoặc thức ăn: Bazel gợi lên hài tây, một loại thực vật. Bạn không cần tìm tên cây cối, thực phẩm hoặc tên liên quan đến "huỳnh quang".
Nếu công cụ của bạn liên quan đến một thương hiệu khác của bên thứ ba, thì chỉ sử dụng nó để mô tả: Ví dụ: sử dụng "Trình di chuyển Bazel cho Cmake" thay vì "Máy di chuyển CMake Bazel".
Những nguyên tắc này cũng áp dụng cho URL kho lưu trữ GitHub. Việc đọc URL kho lưu trữ sẽ giúp mọi người hiểu chức năng của công cụ. Tất nhiên, tên kho lưu trữ có thể ngắn hơn và phải sử dụng dấu gạch ngang thay vì dấu cách và chữ thường.
Ví dụ về tên hay:
- Bazel cho Eclipse: Người dùng sẽ hiểu rằng nếu họ muốn sử dụng Bazel với Eclipse, đây là nơi họ nên tìm kiếm. Công cụ này sử dụng thương hiệu của bên thứ ba làm phần mô tả.
- Bazel buildfarm: "buildfarm" là một trang trại biên dịch. Người dùng sẽ hiểu rằng dự án này liên quan đến việc xây dựng trên máy chủ.
Ví dụ về tên cần tránh:
- Ocimum: Tên khoa học của húng quế không liên quan đủ đến dự án Bazel.
- Bazelizer: Công cụ đằng sau tên này có thể làm được rất nhiều việc, nhưng tên này không đủ mô tả.
Xin lưu ý rằng những đề xuất này phù hợp với các nguyên tắc mà Google sử dụng khi tìm nguồn mở cho một dự án.