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 các nguyên tắc sau đây đối với tên dự án:
Đặt tên cho quy tắc Starlark
Xem phần 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
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ụ: trình bổ trợ IDE mới hoặc trình di chuyển hệ thống xây dựng mới.
Việc chọn một tên phù hợp cho công cụ của bạn có thể rất khó. 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.
Hãy làm theo các nguyên tắc sau để đặt tên cho các công cụ Bazel:
Không nên 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, chúng ta nên tránh gây nhầm lẫn cho họ bằng quá nhiều tên mới.
Ưu tiê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.
Ưu tiên sử dụng tên mô tả chức năng của công cụ: Tốt nhất là tên không cần 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ủ đề hoa hoặc thực phẩm: Bazel gợi nhớ đến cây húng quế. Bạn không cần phải tìm tên là một loại cây, thực phẩm hoặc 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, hãy chỉ sử dụng công cụ đó làm 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 của kho lưu trữ sẽ giúp mọi người hiểu được công cụ này làm gì. 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 hiệu quả:
- Bazel cho Eclipse: Người dùng sẽ hiểu rằng nếu muốn sử dụng Bazel với Eclipse, đây là nơi họ nên tìm. Tên này sử dụng một thương hiệu bên thứ ba làm nội dung mô tả.
- Buildfarm Bazel: "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 nhiều việc, tên này không đủ mô tả.
Xin lưu ý rằng các đề xuất này tuân thủ nguyên tắc mà Google sử dụng khi phát hành nguồn mở một dự án.