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 của Bazel để chia sẻ dự án của bạn và tên dự án.
Nếu đang tạo một công cụ liên quan đến Bazel hoặc chia sẻ các quy tắc của Skylark, bạn nên làm theo những nguyên tắc sau cho tên dự án của mình:
Đặt tên quy tắc Starlark
Hãy 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 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ụ để làm phong phú hệ sinh thái Bazel. Ví dụ: một trình bổ trợ IDE mới hoặc một trình di chuyển hệ thống xây dựng mới.
Việc chọn tên hay cho công cụ của bạn có thể khó khăn. Nếu không cẩn thận và sử dụng quá nhiều tên mã, hệ sinh thái Bazel có thể trở nên rất khó hiểu đối với người mới sử dụng.
Làm theo các nguyên tắc đặt tên công cụ Bazel sau đây:
Không 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. Do đó, chúng ta nên tránh làm cho họ nhầm lẫn với quá nhiều tên mới.
Ưu tiên sử dụng tên có chứa "Bazel": Tên này giúp thể hiện rằng đây là công cụ liên quan đến Bazel, đồng thời giúp mọi người tìm thấy tên đó bằng công cụ tìm kiếm.
Ưu tiên sử dụng tên mô tả về chức năng của công cụ: Lý tưởng nhất là tên không cần phụ đề để người dùng có thể đoán chính xác nhất định chức năng của công 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 hay để đạt được điều này.
Không bắt buộc phải sử dụng giao diện hoa hoặc đồ ăn: Bazel gợi nhớ về húng quế, loại cây này. Bạn không cần tìm tên là cây, thực phẩm hoặc liên quan đến "húng quế".
Nếu công cụ của bạn liên quan đến một thương hiệu bên thứ ba khác, chỉ sử dụng công cụ đó làm phần mô tả: Ví dụ: sử dụng "Trình di chuyển Bazel cho Cmake" thay vì "Trình 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 được chức năng của công cụ này. 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ữ cái viết 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, thì đây là nơi họ nên tìm kiếm. Nó sử dụng thương hiệu của bên thứ ba làm nhã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 có liên quan đến việc xây dựng trên các máy chủ.
Ví dụ về tên mà bạn cần tránh:
- Ocimum: Tên khoa học là húng quế không liên quan nhiều đến dự án Bazel.
- Bazelizer: Công cụ đằng sau tên này có thể giúp bạn làm 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ạo nguồn mở cho một dự án.