README + Jalankan dengan Satu Perintah
Kamu punya tata letak yang rapi dan tes yang nyata. Bagian terakhir adalah bagian yang pertama kali dilihat peninjau: README dan satu perintah untuk menjalankan semuanya. Proyek yang butuh sepuluh menit tebak-tebakan untuk dijalankan terasa rusak meskipun berhasil jalan. Proyek yang bisa kamu clone dan jalankan dengan satu baris terasa profesional meskipun kecil. Kode yang sama -> kesan yang sangat berbeda.
README adalah sebuah kontrak. Pembaca membacanya dari atas ke bawah, dan mereka mengharapkan bentuk yang bisa ditebak: nama proyek sebagai judul, lalu cara instalasinya, lalu cara menggunakannya, lalu cara mengujinya. Secara konkret, README yang bagus punya baris judul tingkat atas (# Something), lalu bagian-bagian ini dengan urutan ini:
# 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
Urutan itu penting karena pembaca mengikutinya sebagai langkah demi langkah. Penggunaan sebelum Setup itu membingungkan -> kamu tidak bisa menggunakan apa yang belum kamu instal. Jadi kamu menulis pengecek, validate_readme(text), yang mengembalikan True hanya jika judul # muncul, diikuti oleh ## Setup, lalu ## Usage, lalu ## Tests, masing-masing setelah yang sebelumnya. Bagian yang hilang, atau bagian yang tidak berurutan, mengembalikan False. Triknya: telusuri baris sekali, simpan "kursor" di mana kamu berada, dan minta setiap bagian muncul di posisi after kursor.
Jalankan dengan satu perintah. Perhatikan ## Usage baris di atas adalah satu perintah tunggal. Itulah tujuan dari target Makefile atau justfile seperti make run -> satu perintah yang mudah diingat untuk menjalankan proyek, jadi tidak ada yang perlu mengingat pemanggilan lengkap. Tulis make_run(name) yang mengembalikan string perintah untuk sebuah proyek, contohnya python -m triage (atau make run). Ini harus menyertakan nama proyek, dinormalisasi dengan cara yang sama seperti direktori paket, jadi proyek yang berbeda menghasilkan perintah yang berbeda.
Dua catatan jujur tanpa nilai untuk repo asli. Pertama, rahasia: langkah cp .env.example .env ada karena API key asli kamu masuk ke .env, yang kamu tambahkan ke .gitignore dan never commit. Kamu hanya commit .env.example -> bentuk shape dari config dengan nilai placeholder. Membocorkan key ke repo publik adalah kesalahan proyek portofolio yang klasik. Kedua, deploying this: untuk mengonlinekannya kamu akan menulis Dockerfile kecil (copy repo, pip install, atur run command sebagai entrypoint) dan push ke PaaS seperti Render, Railway, atau Fly. Bagian itu tidak bisa dijalankan atau dinilai di browser kamu -> itu tugas kamu saat kamu publish. Tekan Run untuk memvalidasi README lengkap dan mencetak run command.
Tulis dua bagian deterministik dari README yang bagus. validate_readme(text) mengembalikan True jika judul # tingkat atas muncul, lalu ## Setup, lalu ## Usage, lalu ## Tests, masing-masing setelah sebelumnya (bagian hilang atau urutan salah -> False). make_run(name) mengembalikan string jalankan satu perintah (misalnya python -m <pkg> atau make run) yang menyertakan nama proyek, dinormalisasi seperti direktori paket, jadi nama yang berbeda menghasilkan perintah yang berbeda.
Ada masalah di pelajaran ini? Laporkan · Tanya tentang pelajaran ini
Latihan ini akan segera dibuka
Selesaikan pelajaran sebelumnya agar pelajaran ini terbuka. Seluruh kursus ini gratis, tidak butuh akun, dan kamu bisa baca pelajaran ini sekarang.
Browser ini memblokir cookie untuk learn.floati.life, jadi pelajaran yang sudah kamu selesaikan di sini tidak bisa dibuka berurutan. Izinkan cookie untuk situs ini dan muat ulang.