انتظار می رود که مطالب کتاب خاصیت های زیر را داشته باشند
- مطلب درست باشد :)
- خواننده ای که کتاب را دنبال کرده قادر به فهم آن باشد
- ارجاع به چیز پیچیده ای خارج از کتاب نداشته باشد
- برای فهم بهتر مطلب از عکس استفاده شود.
در این بخش قرارداد هایی برای یک دست بودن استایل کتاب قرار می دهیم.
- کامنت های کد ها به صورت فینگیلیش نوشته شود.
- سوال ها در پوشه problems و به فرمت yaml است.
- حتما سوال ها در لایه سوم قرار بگیرند
- یعنی پوشه فصل / پوشه زیر فصل / فایل سوال
- سوالات تئوری
- هر کدام یک فایل جدا هستند.
- اسمشان شماره سوال است.
- پارامتر ها
- text: اجباری و به صورت مارک داون
- hint: اختیاری - مارک داون
- solution: اختیاری - مارک داون
- cat: اختیاری - یکی زیر مجموعه از علامت های *!+- طبق کتاب وست
- سوالات کد
- درون فایل extra.yaml قرار می گیرند.
- آرایه ای از سوال ها هستند
- پارامتر های هر سوال
- name: اجباری - یک رشته فارسی
- hint: اختیاری - مارک داون
- solution: اختیاری - مارک داون
- cat: اختیاری - یکی زیر مجموعه از علامت های *!+- طبق کتاب وست
- سعی کنید سوالات نسبت به سختی حدودا مرتب باشند
- خیلی سخت نگیرید. همین که یک سوال بدیهی در انتهای سوالات نباشد کافیست
- چون شیفت دادن سوالات سخت و زمان بر است، به جای شیفت دادن یک سوال مناسب را پیدا کرده و با آن swap کنید.
- حتما از اعداد طبیعی برای نام گذاری سوالات استفاده کنید.