فایل README + اجرای یکدستوری
شما یک چیدمان تمیز و تستهای واقعی دارید. آخرین مرحله همان بخشی است که بازبینها در واقع اول به آن میرسند: README و آن یک دستور که برنامه را اجرا میکند. پروژهای که راهاندازیاش ده دقیقه حدسزدن میطلبد، حتی وقتی کار میکند هم خراب به نظر میرسد. پروژهای که میتوانید با یک خط کد کلون کرده و اجرا کنید، حتی اگر کوچک باشد هم حرفهای به نظر میرسد. همان کد -> تأثیر کاملاً متفاوت.
خواندنی یک قرارداد است. یک خواننده آن را از بالا تا پایین مرور میکند و انتظار یک ساختار قابلپیشبینی را دارد: نام پروژه بهعنوان عنوان، سپس نحوه نصب آن، سپس نحوه استفاده از آن، سپس نحوه آزمایش آن. بهطور مشخص، یک README قوی دارای یک خط عنوان در سطح بالا است (# Something)، سپس این بخشها به این ترتیب:
# Triage Copilot
## Setup
pip install -e . # editable install
cp .env.example .env # then paste your real key into .env
## Usage
python -m triage # the one-command run
## Tests
pytest
ترتیب مهم است چون خواننده آن را مانند مراحل دنبال میکند. استفاده قبل از راهاندازی گیجکننده است -> شما نمیتوانید از چیزی که نصب نکردهاید استفاده کنید. بنابراین یک بررسیگر مینویسید، validate_readme(text)، که بازمیگردد True فقط اگر a # عنوان ظاهر میشود، و پس از آن ## Setup، سپس ## Usage، سپس ## Tests، هر یک پس از قبلی. بازگشت یک بخش گمشده یا بخشهایی که خارج از ترتیب هستند Falseترفند: یکبار خطوط را پیمایش کنید، یک «نماگر» از محل فعلی خود نگه دارید و از هر بخش بخواهید در موقعیتی مشخص ظاهر شود. بعد از نشانگر
اجرای یکفرمانی. توجه کنید به ## Usage خط بالا یک دستور واحد است. این هدف یک هدف Makefile یا justfile مانند make run -> یک دستور بهیادماندنی که پروژه را راهاندازی میکند، تا هیچکس مجبور نباشد کل فراخوانی را به خاطر بسپارد. بنویس make_run(name) که رشتهٔ فرمان مربوط به یک پروژه را بازمیگرداند، برای مثال. python -m triage (یا make runباید نام پروژه را در آن بگنجاند، بهگونهای که مانند دایرکتوری بسته نرمالسازی شود، تا پروژهٔ متفاوت دستور متفاوتی تولید کند.
دو یادداشت صادقانه و بدون نمره برای بازخرید واقعی. ابتدا، اسرار: cp .env.example .env این مرحله وجود دارد زیرا کلید API واقعی شما در آن وارد میشود. .env، که به آن اضافه میکنید .gitignore و هرگز متعهد نشو. شما فقط متعهد میشوید .env.example -> آن شکل از پیکربندی با مقادیر نگهدارندهٔ موقت. نشت یک کلید به مخزن عمومی، اشتباه کلاسیک پروژههای پرتفولیو است. دوم، راهاندازی اینبرای اینکه آن را آنلاین قرار دهید، یک برنامهٔ کوچک مینوشتید. Dockerfile (مخزن را کپی کنید، pip install، دستور run را بهعنوان نقطهٔ ورود تنظیم کنید) و آن را به یک پلتفرم بهعنوان سرویس (PaaS) مانند Render، Railway یا Fly ارسال کنید. آن بخش در مرورگر شما اجرا یا نمرهدهی نمیشود -> این کار را هنگام انتشار انجام میدهید. فشار دهید دوندن برای اعتبارسنجی یک README کامل و چاپ فرمان اجرا.
دو بخش قطعی یک README خوب را بنویسید. validate_readme(text) مقدار True را برمیگرداند اگر و تنها اگر یک عنوان # در سطح بالا ظاهر شود، سپس ## Setup، سپس ## Usage، سپس ## Tests و سپس False، هر کدام پس از قبلی (در صورت وجود بخش مفقود یا بخشهای خارج از ترتیب -> make_run(name) رشتهٔ اجرای یک دستور را بازمیگرداند (مثلاً python -m <pkg> یا make run) که نام پروژه را در خود جای داده و مانند پوشهٔ بسته نرمالسازی شده است، بنابراین نام متفاوت دستور متفاوتی را به همراه دارد.
مشکلی در این درس دیدید؟ گزارشش کنید · دربارهٔ این درس بپرسید
این تمرین بهزودی باز میشود
درس پیش از آن را تمام کنید تا این یکی باز شود. کل دوره رایگان است، حساب کاربری لازم نیست، و میتوانید همین الان این درس را بخوانید.
این مرورگر کوکیهای learn.floati.life را مسدود میکند، پس درسهایی که اینجا تمام کردید نمیتوانند به ترتیب باز شوند. کوکیها را برای این سایت مجاز کنید و صفحه را دوباره بارگذاری کنید.