ابتدا از شما برای کمک به اکوسیستم بازل سپاسگزاریم! لطفاً با انجمن Bazel در لیست پستی bazel-discuss تماس بگیرید تا پروژه خود و نام پیشنهادی آن را به اشتراک بگذارید.
اگر در حال ساخت ابزار مرتبط با Bazel هستید یا قوانین Skylark خود را به اشتراک می گذارید، توصیه می کنیم این دستورالعمل ها را برای نام پروژه خود دنبال کنید:
نام گذاری قوانین Starlark
به استقرار قوانین جدید Starlark در اسناد مراجعه کنید.
نام بردن سایر ابزارهای مرتبط با بازل
اگر در حال ساخت ابزاری برای غنی‌سازی اکوسیستم بازل هستید، این بخش اعمال می‌شود. به عنوان مثال، یک پلاگین جدید IDE یا یک سیستم انتقال دهنده جدید.
انتخاب یک نام خوب برای ابزار شما می تواند سخت باشد. اگر مراقب نباشیم و از نام های رمز زیادی استفاده کنیم، درک اکوسیستم Bazel برای تازه واردان بسیار دشوار خواهد بود.
دستورالعمل های زیر را برای نام گذاری ابزار Bazel دنبال کنید:
ترجیح می‌دهید نام تجاری جدیدی معرفی نکنید : " بازل " در حال حاضر یک برند جدید برای کاربران ما است، باید از اشتباه گرفتن آنها با نام‌های جدید زیاد خودداری کنیم.
ترجیحاً از نامی استفاده کنید که شامل «بازل» باشد : این به بیان این که یک ابزار مرتبط با Bazel است کمک می‌کند، همچنین به افراد کمک می‌کند آن را با موتور جستجو پیدا کنند.
ترجیحاً از نام‌هایی استفاده کنید که توصیفی در مورد کاری که ابزار انجام می‌دهد : در حالت ایده‌آل، نام نباید به زیرنویس نیاز داشته باشد تا کاربران اولین حدس زدن خوبی در مورد عملکرد ابزار داشته باشند. استفاده از کلمات انگلیسی جدا شده با فاصله راه خوبی برای دستیابی به این هدف است.
استفاده از تم گل یا غذا الزامی نیست : بازل تداعی کننده گیاه ریحان است. لازم نیست به دنبال نامی باشید که گیاه، غذا یا مربوط به "ریحان" باشد.
اگر ابزار شما به برند شخص ثالث دیگری مربوط می شود، از آن فقط به عنوان توصیفگر استفاده کنید: به عنوان مثال، به جای «Cmake Bazel migrator» از «Bazel migrator for Cmake» استفاده کنید.
این دستورالعمل ها برای URL مخزن GitHub نیز اعمال می شود. خواندن URL مخزن باید به مردم کمک کند تا بفهمند ابزار چه کاری انجام می دهد. البته نام مخزن می تواند کوتاهتر باشد و باید به جای فاصله و حروف کوچک از خط تیره استفاده شود.
نمونه هایی از نام های خوب:
- Bazel برای Eclipse : کاربران متوجه خواهند شد که اگر می‌خواهند از Bazel با Eclipse استفاده کنند، اینجاست که باید به دنبال آن باشند. از یک برند شخص ثالث به عنوان توصیفگر استفاده می کند.
- Bazel buildfarm : "بیلدفارم" یک مزرعه کامپایل است. کاربران متوجه خواهند شد که این پروژه به ساختن روی سرورها مربوط می شود.
نمونه هایی از نام هایی که باید اجتناب کرد:
- Ocimum : نام علمی ریحان به اندازه کافی با پروژه Bazel مرتبط نیست.
- Bazelizer : ابزاری که در پشت این نام قرار دارد می تواند کارهای زیادی انجام دهد، این نام به اندازه کافی توصیفی نیست.
توجه داشته باشید که این توصیه‌ها با دستورالعمل‌هایی که Google هنگام منبع‌دهی باز پروژه استفاده می‌کند، همسو هستند.