راهنمای مشارکت

یک فصل چه شکلی است

هر فصل یک فایل HTML در پوشهٔ content است: content/<نام مسیر>/<نام فصل>.html. بالای فایل یک سربرگ کوتاه می‌آید و بعد از آن، بخش‌ها. هر بخش یک section با id است که خودش در فهرست مطالب و در محاسبهٔ پیشرفت می‌نشیند.

<!--meta
title: عنوان فصل
desc:  یک جملهٔ کوتاه برای موتور جستجو
-->

<section id="why">
  <h2><span lang="fa">چرا این کار</span><span lang="en">Why this</span></h2>
  <p lang="fa">متن فارسی…</p>
  <p lang="en">English text…</p>
</section>

متن فارسی و انگلیسی کنار هم می‌آیند و سوییچ زبان یکی را پنهان می‌کند؛ پس هر جمله باید هر دو نسخه را داشته باشد. کلاس‌های آماده‌ای هم هست که در همهٔ فصل‌ها یکسان‌اند:

معیار کیفیت

یک فصل وقتی آماده است که همهٔ این‌ها را داشته باشد. این فهرست سخت‌گیرانه است، چون هدف پروژه مرجع بودن است نه معرفی.

• دست‌کم ۴۵۰۰ کلمهٔ فارسی، با نسخهٔ انگلیسی کنارش
• دست‌کم ۱۸ تمرین، از ساده به سخت، هر کدام با راهنمایی، پاسخ کامل و خروجی مورد انتظار
• دست‌کم ۳۰ بلوک کد یا ترمینال با خروجی واقعی
• دست‌کم دو نمودار و یک جدول مقایسه
• دست‌کم چهار دام، هر کدام با پیام خطای دقیق و راه‌حل
• یک مرجع سریع و یک پروژهٔ پایان فصل
• هر دستور قبل از انتشار اجرا شده باشد — خروجی حدسی ممنوع

اجرای پروژه روی سیستم خودت

1. ۱

   کلون کن

   git clone https://github.com/SeyedAb2/code-name.git
   cd code-name
   npm install

2. ۲

   اجرا کن

   npm run dev   # http://localhost:3000
   npm run build # ساخت نسخهٔ نهایی

3. ۳

   بنویس

   فایل فصل را در content/ بساز و در فهرست مسیرها ready را برایش روشن کن. صفحهٔ فصل خودش ساخته می‌شود.

4. ۴

   Pull Request بفرست

   هر PR یک موضوع. پیام کامیت انگلیسی و کوتاه. اگر فصل نوشته‌ای، در توضیح PR بگو کدام دستورها را روی چه سیستمی اجرا کرده‌ای.