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ư bazel-discuss để chia sẻ dự án và tên đề xuất của dự án.
Nếu đang xây dựng 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 những nguyên tắc sau về tên dự án:
Đặt tên cho các quy tắc Starlark
Xem bài viết Triển khai 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
Mục 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 bản dựng mới.
Việc chọn một tên hay cho công cụ có thể rất khó. Nếu không cẩn thận và sử dụng quá nhiều tên mã, thì người mới có thể rất khó hiểu về hệ sinh thái Bazel.
Hãy làm theo những nguyên tắc sau để đặt tên cho các công cụ Bazel:
Nên không giới thiệu tên thương hiệu mới: "Bazel" đã là một thương hiệu mới đối với người dùng của chúng tôi. Chúng ta nên tránh làm họ nhầm lẫn với quá nhiều tên mới.
Nên sử dụng tên có chứa "Bazel": Điều này giúp thể hiện rằng đó là một công cụ liên quan đến Bazel, đồng thời giúp mọi người tìm thấy công cụ đó bằng công cụ tìm kiếm.
Nên sử dụng tên mô tả về chức năng của công cụ: Tốt nhất là tên không cần có phụ đề để người dùng có thể đoán được chức năng của công cụ ngay từ đầu. 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 chủ đề về hoa hoặc thực phẩm: Bazel gợi nhớ đến cây húng quế. Bạn không cần tìm một 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 khác của bên thứ ba, hãy chỉ sử dụng thương hiệu đó làm bộ 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ụ. 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 for Eclipse: Người dùng sẽ hiểu rằng nếu muốn sử dụng Bazel với Eclipse, thì đây là nơi họ nên tìm. Tên này sử dụng thương hiệu của bên thứ ba làm bộ 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 cây húng quế không liên quan đủ đến dự án Bazel.
- Bazelizer: Công cụ đằng sau tên này có thể thực hiện nhiều việc, tên này không đủ tính 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 cung cấp mã nguồn mở cho một dự án.