Mudah untuk Diselenggara
Bina perisian yang boleh difahami, diubah suai, dan diperluas dengan mudah oleh pemaju masa depan
Struktur Projek yang Jelas & Seni Bina Modular
Kami memastikan struktur folder adalah perkara pertama yang akan dinilai oleh pemaju masa depan. Struktur folder yang berpendapat dan konsisten digunakan (contohnya, src/components, src/services, src/hooks, src/features).
Standard Kod yang Boleh Dibaca dan Ramalan
Kami menulis kod untuk manusia, bukan hanya untuk penyusun. Konvensyen dan corak penamaan yang konsisten diikuti di seluruh projek. ESLint dan Prettier disediakan untuk menguatkuasakan pemformatan melalui pre-commit hooks seperti Husky, memastikan kualiti kod dari awal. Kami mengutamakan bahasa bertipe, menggunakan TypeScript berbanding JavaScript untuk penyelenggaraan yang lebih baik. Kami sentiasa memastikan kod boleh dibaca dan boleh diurus, fokus dan kecil.
Sistem Reka Bentuk Bersama / Perpustakaan Komponen
Kami mengelakkan kekacauan reka bentuk dengan menyandarkan keputusan reka bentuk dalam komponen kod yang boleh digunakan semula. Sistem komponen yang ditetapkan seperti ShadCN, Tailwind UI, atau Material UI digunakan untuk memastikan konsistensi di seluruh projek. Pendekatan ini membantu mengelakkan penulisan kod UI sekali sahaja kecuali benar-benar perlu, menjimatkan masa dan memastikan konsistensi reka bentuk.
Logik Perniagaan Terkapsul
Kami memastikan logik perniagaan tidak pernah berada di lapisan UI. Lapisan perkhidmatan, custom hooks, atau modul pengawal digunakan untuk mengasingkan dan mengatur logik perniagaan dengan betul. Untuk interaksi API, corak pengambilan data moden dilaksanakan menggunakan SWR, React Query, atau pembungkus khusus yang mengendalikan caching dan keadaan ralat dengan cekap. Semua panggilan API diasingkan ke dalam folder perkhidmatan khusus, seperti services/api/user.ts, menjadikan kod lebih mudah diselenggara dan diuji.
Dokumentasi: Kekalkan Ia Ringan Tetapi Berguna
Kami tidak menulis novel—cukup untuk mempercepatkan pengenalan dev seterusnya. README.md sentiasa ditulis dengan setup, env vars, arahan penyebaran. Komen pendek ditambah untuk logik yang kompleks (jangan berlebihan memberi komen). TSDoc / JSDoc digunakan untuk kaedah awam. A CONTRIBUTING.md ditambah untuk cara menjalankan ujian / konvensyen.
Liputan Ujian (Hanya Laluan Kritikal)
Kami tidak memerlukan liputan 100%, tetapi kami memerlukan liputan lengkap di mana kegagalan adalah mahal. Ujian unit diprioritaskan untuk fungsi kritikal perniagaan. Ujian integrasi digunakan untuk titik akhir API atau aliran kerja. Alat yang mudah digunakan dipilih: Jest + Testing Library (React), Playwright untuk e2e. Jadi kami dapat mengekalkan keseimbangan antara liputan dan masa untuk pasaran.
CI/CD + Automasi Kualiti Kod
Setiap komit mencetuskan pemeriksaan keselamatan. Pipeline CI/CD yang sederhana disediakan yang melakukan: Pemeriksaan jenis (contohnya, tsc --noEmit), pemeriksaan Lint/format, ujian unit, Auto-deploy ke staging. Alat biasa digunakan: GitHub Actions, Docker Compose.
Pemisahan Konfigurasi dari Kod
Kami mengelakkan sebarang hardcoded = kesakitan jangka panjang. Semua rahsia/config disimpan dalam .env atau konfigurasi jauh (contohnya, AWS SSM, persekitaran Vercel). Setup berasaskan persekitaran digunakan (process.env.NODE_ENV). Mengkomit .env.*, kunci API, kelayakan, dll. dielakkan. Dan ia didokumenkan dengan baik.