در مستندسازی بازل مشارکت کنید

با تشکر از شما برای مشارکت در مستندات Bazel! چند راه برای کمک به ایجاد اسناد بهتر برای جامعه ما وجود دارد.

انواع اسناد

این سایت شامل چند نوع محتوا می باشد.

  • مستندات روایی که توسط نویسندگان فنی و مهندسین نوشته شده است. بیشتر این سایت مستندات روایی است که راهنماهای مفهومی و مبتنی بر وظیفه را پوشش می دهد.
  • مستندات مرجع ، که مستندات از نظرات کد ایجاد می شود. شما نمی توانید مستقیماً در صفحات سند مرجع تغییرات ایجاد کنید، اما در عوض باید منبع آنها را تغییر دهید.

زیرساخت مستندسازی

اسناد Bazel از Google ارائه می شود و فایل های منبع در مخزن Bazel's GitHub منعکس می شوند. می توانید در GitHub تغییراتی در فایل های منبع ایجاد کنید. در صورت تایید، می توانید تغییرات را ادغام کنید و یک نگهدارنده Bazel منبع وب سایت را برای انتشار به روز رسانی های شما به روز می کند.

تغییرات کوچک

شما می توانید به چند روش به تغییرات کوچک مانند رفع خطاها یا اشتباهات تایپی نزدیک شوید.

  • درخواست کشش می توانید یک درخواست کشش در GitHub با ویرایشگر مبتنی بر وب یا در یک شعبه ایجاد کنید.
  • اشکال شما می توانید یک اشکال را با جزئیات و تغییرات پیشنهادی ثبت کنید و صاحبان اسناد Bazel به روز رسانی را انجام می دهند.

تغییرات بزرگ

اگر می‌خواهید تغییرات اساسی در اسناد موجود ایجاد کنید یا اسناد جدیدی را پیشنهاد دهید، می‌توانید یک درخواست کشش ایجاد کنید یا با یک سند Google شروع کنید و برای همکاری با مالکان Bazel تماس بگیرید.