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ề dự án để chia sẻ dự án và tên đề xuất của dự án.
Nếu bạn đang tạo một công cụ liên quan đến Bazel hoặc chia sẻ các quy tắc Skylark của mình, bạn nên làm theo các nguyên tắc sau đối với tên dự án:
Đặt tên quy tắc Starlark
Xem phần Triển khai các quy tắc Starlark mới trong các tài liệu.
Đặt tên cho các công cụ khác 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 xây dựng mới.
Không dễ để chọn được tên hay cho công cụ của mình. Nếu chúng tôi không cẩn thận và cũng sử dụng nhiều tên mã, hệ sinh thái Bazel có thể trở nên rất khó hiểu cho người mới tham gia.
Hãy làm theo các nguyên tắc sau để đặt tên cho công cụ Bazel:
Bạn muố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, chúng ta không nên nhầm lẫn họ với quá nhiều tên mới.
Ưu tiên sử dụng tên có từ "Bazel": Điều này giúp thể hiện rằng tên này là một công cụ có liên quan đến Bazel, công cụ này cũng giúp mọi người tìm thấy nó 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 nên cần phụ đề để người dùng có cái tên hay đoán chức năng của công cụ đó. Dùng các từ tiếng Anh được phân tách bằng dấu cách là một cách hữu ích để đạt được mục tiê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úng quế, loại cây này. Bạn không cần hãy tìm tên thực vật, thực phẩm hoặc tên liên quan đến "húng quế".
Nếu công cụ của bạn có 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 "di chuyển Bazel cho Cmake" thay vì "Cmake Bazel di trú".
Những nguyên tắc này cũng áp dụng cho URL kho lưu trữ GitHub. Đọc kho lưu trữ URL phải giúp người dùng hiểu được chức năng của công cụ này. Tất nhiên, kho lưu trữ tên 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. Quảng cáo sử dụng thương hiệu của bên thứ ba làm phần mô tả.
- Bazel buildfarm: "buildfarm" là tổng hợp nông trại. 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 rất nhiều việc, tên này là chưa đủ mô tả.
Xin lưu ý rằng các đề xuất này phù hợp với nguyên tắc Google sử dụng khi tìm nguồn mở cho một dự án.