web configs
@shopify
يحتوي هذا المستودع على تكوينات شائعة لبناء تطبيقات الويب في Shopify.
تتم إدارة هذا الريبو باعتباره monorepo الذي يتكون من العديد من حزم NPM ، حيث كل حزمة لها README ووثائقها التي تصف الاستخدام.
| اسم | NPM | مقاس |
|---|---|---|
| بابل بريشست | ||
| BrowsersList-Config | ||
| eslint-plugin | ||
| الصور | ||
| postcss-plugin | ||
| أجمل config | ||
| 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 هنا.
إذا كان تغييرك يؤثر على واجهة برمجة التطبيقات العامة لأي حزم داخل هذا المستودع (أي إضافة أو تغيير الوسيطات إلى وظيفة ، وإضافة وظيفة جديدة ، وتغيير قيمة الإرجاع ، وما إلى ذلك) ، يرجى التأكد من تحديث الوثائق ، وإضافة changelog لتعكس ذلك. الوثائق موجودة في ملفات README.md لكل حزمة. إذا كانت هناك حاجة إلى مزيد من الوثائق ، فيرجى التواصل عبر مشكلة github.
يتم استخدام الحزم في هذا المستودع في سيناريوهات الإنتاج المهمة. على هذا النحو ، نحن لا ندمج أي رمز غير اختبار.
لتشغيل جناح الاختبار الكامل ، ما عليك سوى تشغيل dev test أو yarn test .
تتضمن عملية الإصدار حاليًا بعض الخطوات اليدوية لإكمالها. بمجرد دمج العلاقات العامة الخاصة بك ، سيقوم فريقنا بتنظيم وقت خفض إصدار جديد.
ملاحظة لا ينبغي أبدًا تغيير أرقام الإصدار في package.json يدويًا. سيتم ذلك عبر البرامج النصية كجزء من عملية الإصدار.
MIT © Shopify ، انظر الترخيص.
