web configs

Konfigurasi web

Repositori ini berisi konfigurasi umum untuk membangun aplikasi web di Shopify.

Penggunaan

Repo ini dikelola sebagai monorepo yang terdiri dari banyak paket NPM, di mana setiap paket memiliki README sendiri dan dokumentasi yang menggambarkan penggunaan.

Indeks paket

Nama	NPM	Ukuran
Babel-preset
Browserslist-Config
Eslint-plugin
gambar
POSTCSS-PLUGIN
config-config yang lebih cantik
stylelint-plugin
Tipe-configs

Kontribusi

Repositori ini memiliki CLA-Bot Running yang akan meminta kontributor untuk menandatangani perjanjian lisensi kontributor (CLA).

Shopify juga telah mengadopsi kode etik yang kami harapkan sebagai kontributor untuk dipatuhi. Harap baca teks lengkapnya sehingga Anda dapat memahami tindakan apa yang akan dan tidak akan ditoleransi.

Cara berkontribusi

Ada banyak cara untuk berkontribusi, beberapa di antaranya adalah:

• Mengajukan laporan bug
• Meminta fitur atau paket baru melalui masalah
• Meningkatkan basis kode yang ada dengan mengambil masalah, meningkatkan tes, atau memajukan dokumentasi

Perkembangan

Memulai

 # Shopify Employee
dev clone web-configs
dev up

# External Contributor - To start working on the codebase, first fork the repo, then clone it
git clone [email protected]:{your-username}/web-configs.git # replace {your-username} with your GitHub handle
yarn # install project dependencies 

APA ITU dev ?

dev adalah alat untuk menstandarkan serangkaian kecil tugas umum di semua proyek di Shopify. Jika Anda bertanya -tanya bagaimana cara menjalankan perintah dev sebagai kontributor eksternal, Anda dapat melihat di mana mereka didefinisikan dalam file dev.yml proyek ini.

Menguji perubahan Anda dalam proyek lokal

Untuk mencoba perubahan Anda dalam proyek kloning lokal lainnya, Anda dapat menggunakan yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> . Menggunakan perintah ini daripada yarn link akan mengatur pengamat memungkinkan Anda melakukan perubahan tanpa perlu menjalankan kembali perintah apa pun.

Contoh: Untuk menguji perubahan saya pada @shopify/react-form-state dalam proyek lokal saya bernama my-project , saya akan menjalankan yarn tophat react-form-state ../path/to/my-project .

Lebih banyak instruksi penggunaan pada perintah tophat dapat ditemukan di sini.

Dokumentasi

Jika perubahan Anda memengaruhi API publik dari setiap paket dalam repositori ini (yaitu menambahkan atau mengubah argumen ke suatu fungsi, menambahkan fungsi baru, mengubah nilai pengembalian, dll), pastikan dokumentasi diperbarui, dan changelog ditambahkan untuk mencerminkan hal ini. Dokumentasi ada di file README.md dari setiap paket. Jika dokumentasi lebih lanjut diperlukan, silakan berkomunikasi melalui masalah GitHub.

Pengujian

Paket-paket dalam repositori ini digunakan dalam skenario produksi misi-kritis. Karena itu, kami tidak menggabungkan kode yang belum diuji.

Untuk menjalankan test suite lengkap, cukup jalankan dev test atau yarn test .

Melepaskan

Proses rilis saat ini melibatkan beberapa langkah manual untuk diselesaikan. Setelah PR Anda digabungkan, tim kami akan mengatur kapan harus memotong rilis baru.

Catatan nomor versi dalam file package.json tidak boleh diubah secara manual. Ini akan dilakukan melalui skrip sebagai bagian dari proses rilis.

Lisensi

MIT © Shopify, lihat lisensi.md untuk detailnya.