آماده‌سازی برای عرضه


پیش از آنکه آماده‌ی عرضه‌ی ترک خود باشید، لطفاً مطمئن شوید که کارهای زیر انجام شده‌اند.

درخواست آیکون ترک

برای طراحی آیکونی برای سایت، یک ایشوی جدید در مخزن exercism/website-icons باز کنید و به پرسش‌های زیر پاسخ دهید:

  • آیا زبان لوگوی رسمی دارد؟ اگر دارد
    • لطفاً پیوندی به یک نمونه بدهید
    • لطفاً الزامات ذکر منبع و حقوق داده‌شده برای استفاده از آن لوگو را فهرست کنید
  • آیا زبان لوگوی غیررسمی دارد؟ اگر دارد
    • لطفاً توضیح دهید که مردم از لوگوی غیررسمی به چه شکل‌هایی استفاده می‌کنند
    • لطفاً پیوندی به یک نمونه بدهید
    • لطفاً الزامات ذکر منبع آن لوگو را فهرست کنید

افزودن مستندات ترک

مستندات زیر را برای ترک اضافه کنید:

  • docs/ABOUT.md: معرفی کوتاهی از زبان.
  • docs/INSTALLATION.md: توضیح دهید دانشجو برای کار روی ترک در سیستم محلی خود با استفاده از CLI چه چیزهایی باید نصب کند.
  • docs/LEARNING.md: پیوندهایی به منابع یادگیری.
  • docs/RESOURCES.md: پیوندهایی به منابع مفید.
  • docs/TESTS.md: هر آنچه به اجرای آزمون‌ها در ترک مربوط است را توضیح دهید.

این مستندات به دانشجو کمک می‌کند تا کار با ترک را شروع کند و همچنین با ترک و زبان آن آشنا شود. برای اطلاعات بیشتر، مستندات docs را ببینید.

افزودن مستندات تمرین

مستندات زیر را برای تمرین اضافه کنید:

  • exercises/shared/.docs/help.md: شامل دستورالعمل‌های مخصوص ترک درباره‌ی نحوه‌ی گرفتن کمک است
  • exercises/shared/.docs/tests.md: شامل دستورالعمل‌های مخصوص ترک درباره‌ی نحوه‌ی اجرای آزمون‌ها است

افزودن قطعه‌کد

یک قطعه‌کد به فایل docs/SNIPPET.txt اضافه کنید. این قطعه‌کد تصویری از نحوه‌ی نگارش زبان به دست می‌دهد. برای اطلاعات بیشتر، مستندات docs را ببینید.

به‌روزرسانی فراداده

فراداده‌ی ترک در فایل config.json تعریف می‌شود. ویژگی‌های زیر باید به‌روزرسانی شوند:

  • language: زبان ترک (مثلاً "C#"). طول آن باید کوچک‌تر یا مساوی ۲۵۵ باشد
  • slug: زبان ترک به‌صورت رشته‌ای با حروف کوچک و در قالب kebab-case (مثلاً "csharp"). طول آن باید کوچک‌تر یا مساوی ۲۵۵ باشد
  • blurb: توضیح کوتاهی از زبان. طول آن باید کوچک‌تر یا مساوی ۴۰۰ باشد
  • online_editor: شیئی که تنظیمات استفاده‌شده برای ویرایشگر آنلاین را توصیف می‌کند:
    • indent_style: یا "space" یا "tab"
    • indent_size: اندازه‌ی تورفتگی به‌صورت یک عدد صحیح (مثلاً 4)
    • highlightjs_language: شناسه‌ی زبان برای Highlight.js (به فهرست کامل شناسه‌ها مراجعه کنید). اگر Highlight.js از آن پشتیبانی نمی‌کند، می‌توان این فیلد را حذف کرد.
  • key_features: ویژگی‌های کلیدی زبان که مهم‌ترین ویژگی‌های آن را به‌طور موجز توصیف می‌کنند. برای اطلاعات بیشتر، مستندات ویژگی‌های کلیدی را ببینید.
  • tags: برچسب‌هایی که به این ترک مربوط می‌شوند را تعریف کنید؛ این کار جست‌وجوی آن را در وب‌سایت ممکن می‌کند. برای اطلاعات بیشتر و فهرست برچسب‌های پشتیبانی‌شده، مستندات برچسب‌ها را ببینید.