web configs
@shopify
ที่เก็บนี้มีการกำหนดค่าทั่วไปสำหรับการสร้างเว็บแอพที่ Shopify
repo นี้ได้รับการจัดการเป็น monorepo ที่ประกอบด้วยแพ็คเกจ NPM จำนวนมากซึ่งแต่ละแพ็คเกจมี README และเอกสารประกอบของตัวเองที่อธิบายการใช้งาน
| ชื่อ | NPM | ขนาด |
|---|---|---|
| เบลอ | ||
| เบราว์เซอร์ลิสต์-คอน | ||
| eslint-plugin | ||
| ภาพ | ||
| postcss-plugin | ||
| ความเพรียวลม | ||
| Stylelint-Plugin | ||
| typescript-configs |
ที่เก็บนี้มี CLA-bot ที่จะขอให้ผู้มีส่วนร่วมลงนามในข้อตกลงใบอนุญาตผู้สนับสนุน (CLA)
Shopify ยังใช้จรรยาบรรณที่เราคาดหวังให้ผู้มีส่วนร่วมปฏิบัติตาม โปรดอ่านข้อความทั้งหมดเพื่อให้คุณสามารถเข้าใจการกระทำที่จะเกิดขึ้นและจะไม่ได้รับการยอมรับ
มีหลายวิธีในการมีส่วนร่วมบางอย่างคือ:
# 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 dev คืออะไร? dev เป็นเครื่องมือในการสร้างมาตรฐานชุดงานทั่วไปขนาดเล็กในทุกโครงการที่ Shopify หากคุณสงสัยว่าจะดำเนินการคำสั่ง dev เป็นผู้สนับสนุนภายนอกได้อย่างไรคุณสามารถดูว่าพวกเขาถูกกำหนดไว้ที่ไหนในไฟล์ dev.yml ของโครงการนี้
หากต้องการลองการเปลี่ยนแปลงของคุณในโครงการโคลนในพื้นที่อื่นคุณสามารถใช้ yarn tophat <package-name-without-@shopify-prefix> <relative-path-to-project> การใช้คำสั่งนี้แทนที่จะเป็น yarn link จะตั้งค่าผู้เฝ้าดูให้คุณทำการเปลี่ยนแปลงโดยไม่จำเป็นต้องเรียกใช้คำสั่งใด ๆ อีกครั้ง
ตัวอย่าง: ในการทดสอบการเปลี่ยนแปลงของฉันเป็น @shopify/react-form-state ในโครงการท้องถิ่นของฉันชื่อ my-project ฉันจะเรียกใช้ yarn tophat react-form-state ../path/to/my-project
คำแนะนำการใช้งานเพิ่มเติมเกี่ยวกับคำสั่ง tophat สามารถพบได้ที่นี่
หากการเปลี่ยนแปลงของคุณมีผลต่อ API สาธารณะของแพ็คเกจใด ๆ ภายในที่เก็บนี้ (เช่นการเพิ่มหรือเปลี่ยนอาร์กิวเมนต์เป็นฟังก์ชั่นการเพิ่มฟังก์ชั่นใหม่การเปลี่ยนค่าการส่งคืน ฯลฯ ) โปรดตรวจสอบให้แน่ใจว่าเอกสารได้รับการปรับปรุงและเพิ่มการเปลี่ยนแปลงเพื่อสะท้อนสิ่งนี้ เอกสารอยู่ในไฟล์ README.md ของแต่ละแพ็คเกจ หากจำเป็นต้องมีเอกสารเพิ่มเติมโปรดสื่อสารผ่านปัญหา GitHub
แพ็คเกจในพื้นที่เก็บข้อมูลนี้ใช้ในสถานการณ์การผลิตที่มีความสำคัญต่อภารกิจ ดังนั้นเราจึงไม่รวมรหัสที่ยังไม่ผ่านการทดสอบ
ในการเรียกใช้ชุดทดสอบเต็มรูปแบบให้เรียกใช้ dev test หรือ yarn test
กระบวนการเผยแพร่ในปัจจุบันเกี่ยวข้องกับขั้นตอนด้วยตนเองเพื่อให้เสร็จสมบูรณ์ เมื่อการประชาสัมพันธ์ของคุณถูกรวมเข้าด้วยกันแล้วทีมงานของเราจะจัดเตรียมเมื่อใดที่จะตัดการเปิดตัวใหม่
หมายเลขเวอร์ชัน หมายเหตุ ในไฟล์ package.json ไม่ควรเปลี่ยนแปลงด้วยตนเอง สิ่งนี้จะทำผ่านสคริปต์ซึ่งเป็นส่วนหนึ่งของกระบวนการวางจำหน่าย
MIT © Shopify ดูใบอนุญาตสำหรับรายละเอียด
