Comment on page
تنسيق الكود
- يجب أن تحتوي أمثلة ووحدات Terraformعلى توثيق لشرح الخصائص التي تقدمها وكيفية استعمالها
- كل الروابط في ملف README.md يجب أن تكون مطلقة لجعل موقع Terraform Registry يعرضها بشكل صحيح
- يمكن أن يحتوي التوثيق على رسومات تم إنشاؤها باستخدام mermaid أو مخططات تم إنشاؤها باستخدام cloudcraft.co.
- قم باستعمال Terraform pre-commit hooks للتأكد من أن الكود صالح، ومنسق بشكل صحيح، وموثق تلقائيًا قبل دفعه إلى Git واستعراضه من قبل البشر.
إن pre-commit هو إطار عمل لإدارة وصيانة pre-commit hooks متعددة اللغات، مكتوبة بلغة بايثون وهي أداة قوية للقيام ببعض المهام بشكل أتوماتيكي على جهاز المطور قبل الدفع بالكود إلى git repository. تستعمل عادةً لتشغيل linters ولتنسيق الكود ( انظر إلى supported hooks)
مع ملفات Terraform يمكننا استعمال
pre-commit
لتنسيق الكود والتحقق منه بالإضافة إلى تعديل التوثيقإن terraform-docs هي أداة تقوم بتوليد التوثيق من وحدات Terraform وتولد أشكال مختلفة، يمكنك أن تشغلها يدوياً (بدون pre-commit hooks) أو تستعمل إطار عمل pre-commit-terraform hooks لجعل التوثيق يتكون أتوماتيكياً.
@todo: Document module versions, release, GH actions
Last modified 7mo ago