درخواست کشش را ارسال کنید

این صفحه درباره ارسال یک درخواست کشش حاوی فایل‌های مستندات Markdown به tensorflow/tfhub.dev است. GitHub Repo. برای اطلاعات بیشتر در مورد نحوه نوشتن فایل‌های Markdown در وهله اول، لطفاً راهنمای اسناد نوشتن را ببینید.

GitHub Actions را بررسی می کند

مخزن tensorflow/tfhub.dev از اقدامات GitHub برای اعتبارسنجی قالب فایل ها در روابط عمومی استفاده می کند. گردش کار مورد استفاده برای اعتبارسنجی PRها در github/workflows/contributions-validator.yml. تعریف شده است. شما می توانید اسکریپت اعتبار سنجی را در شعبه خود خارج از گردش کار اجرا کنید، اما باید اطمینان حاصل کنید که تمام وابستگی های بسته پیپ صحیح را نصب کرده اید.

مشارکت‌کنندگانی که برای اولین بار می‌توانند بر اساس خط‌مشی GitHub ، فقط با تأیید یک نگهدارنده مخزن، چک‌های خودکار را اجرا کنند. ناشران تشویق می شوند تا اشتباهات املایی کوچکی را برای اصلاح روابط عمومی ارسال کنند، در غیر این صورت اسناد مدل را بهبود می بخشند، یا یک PR را که فقط حاوی صفحه ناشر خود است به عنوان اولین روابط عمومی خود ارسال کنند تا بتوانند بررسی های خودکار را در PR های بعدی انجام دهند.

ارائه روابط عمومی

فایل های Markdown کامل را می توان با یکی از روش های زیر به شاخه اصلی tensorflow/tfhub.dev کشید.

ارسال Git CLI

با فرض اینکه مسیر فایل علامت‌گذاری شناسایی‌شده assets/docs/publisher/model/1.md باشد، می‌توانید مراحل استاندارد Git[Hub] را برای ایجاد یک درخواست کشش جدید با یک فایل جدید اضافه شده دنبال کنید.

این کار با انشعاب مخزن TensorFlow Hub GitHub شروع می شود و سپس یک درخواست کشش از این فورک در شاخه اصلی TensorFlow Hub ایجاد می کند.

در زیر دستورات معمولی CLI git مورد نیاز برای افزودن یک فایل جدید به یک شاخه اصلی از مخزن فورکی هستند.

git clone https://github.com/[github_username]/tfhub.dev.git
cd tfhub.dev
mkdir -p assets/docs/publisher/model
cp my_markdown_file.md ./assets/docs/publisher/model/1.md
git add *
git commit -m "Added model file."
git push origin master

ارسال GitHub GUI

یک راه ساده‌تر برای ارسال، از طریق رابط کاربری گرافیکی GitHub است. GitHub امکان ایجاد PR برای فایل های جدید یا ویرایش فایل ها را مستقیماً از طریق رابط کاربری گرافیکی فراهم می کند.

  1. در صفحه TensorFlow Hub GitHub ، دکمه Create new file را فشار دهید.
  2. مسیر فایل مناسب را تنظیم کنید: assets/docs/publisher/model/1.md
  3. علامت گذاری موجود را کپی-پیست کنید.
  4. در پایین، "Create a new branch for this commit and start a pull request" را انتخاب کنید.