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ư về chủ đề thảo luận về dự án để chia sẻ dự á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 của mình, bạn nên làm theo các nguyên tắc sau đây cho tên dự án của mình:
Đặt tên 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 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 một cái tên hay cho công cụ của mình. Nếu chúng ta 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.
Hãy làm theo các nguyên tắc sau để đặt tên cho công cụ Bazel:
Không muố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 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": Đ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 một công cụ tìm kiếm.
Ưu tiên sử dụng các 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ể dự đoán rõ ràng về chức năng của công cụ này. 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 mục tiê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 lên húng quế, loại cây này. Bạn không cần tìm tên là thực vật, thực phẩm hoặc liên quan đến "hủ húng".
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 nội dung mô tả: Ví dụ: sử dụng "Bazel di chuyển cho Cmake" thay vì "Cmake Bazel migrator".
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 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ữ 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 đến. Mã này sử dụng thương hiệu của bên thứ ba làm phầ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 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ụ phía sau tên này có thể thực hiện 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 nguyên tắc mà Google sử dụng khi tìm nguồn mở cho một dự án.