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 của bạn và tên đề xuất của 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 Skylark, bạn nên tuân thủ những nguyên tắc sau về tên dự án:
Đặt tên cho các 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 liên quan đến Bazel
Phần này áp dụng nếu bạn đang tạo 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 phù hợp cho công cụ của bạn có thể sẽ 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.
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 của chúng tôi, chúng ta nên tránh khiến 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 đây 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ụ này bằng công cụ tìm kiếm.
Nê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ừ lần đầu. Bạn có thể sử dụng các từ tiếng Anh được phân tách bằng dấu cách để đạt được mục tiêu này.
Bạn không bắt buộc phải sử dụng chủ đề hoa hoặc thực phẩm: Bazel gợi nhớ đến húng quế, một loại cây. Bạn không cần 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 khác của bên thứ ba, hãy chỉ dùng thương hiệu đó làm nội dung mô tả: Ví dụ: dùng "Công cụ di chuyển Bazel cho Cmake" thay vì "Công cụ di chuyển Cmake Bazel".
Những nguyên tắc này cũng áp dụng cho URL của 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ì khoảng trắng và chữ cái viết thường.
Ví dụ về tên nên dùng:
- Bazel cho 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 kiếm. Sử dụng thương hiệu của bên thứ ba làm nội dung mô tả.
- Buildfarm Bazel: "Buildfarm" là một compile farm (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 các máy chủ.
Ví dụ về những 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, 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 cung cấp nguồn mở cho một dự án.