پروژه
مشارکت
۲ دقیقه مطالعهبهروزرسانی
ممنون که وقت میذارید و کمک میکنید! اولویت اول این مخزن درستی و دقت اطلاعاته، پس برای هر تغییری لطفا یک منبع معتبر یا تست همراهش بذارید.
چطور میتونید مشارکت کنید؟
پیوند به بخش چطور میتونید مشارکت کنید؟- اصلاح یا بهتر کردن مستندات: صفحات انگلیسی (
docs/en) و فارسی (docs/fa) رو هماهنگ نگه دارید. اگر فقط به یکی از دو زبان مینویسید، توی توضیحات Pull Request بگید تا بقیه در ترجمهش کمک کنن. - اضافه کردن یک زبان برنامهنویسی جدید به
implementations/:- الگوریتم صفحهٔ
docs/fa/03-algorithm.mdرو به زبان مورد نظرتون پیادهسازی کنید. قواعد نامگذاری و استایل همون زبان رو رعایت کنید، اما همین توابع استاندارد رو نگه دارید: تشخیص سال کبیسه، تعداد روزهای ماه، اعتبارسنجی تاریخ، تبدیل از/به JDN، تبدیل از/به میلادی، روز هفته (۰ = شنبه) و شمارهٔ روز در سال. - یک فایل تست بنویسید که
data/years.csvوdata/test-vectors.csvرو بخونه، تکتک روزهای سال ۱۱۷۸ تا ۳۰۰۰ رو دوطرفه تبدیل و چک کنه و اعتبارسنجی ورودیها رو هم تست کنه (میتونید از تستهای زبانهای دیگه الگو بگیرید). - یک job به فایل
.github/workflows/test.ymlو یک سطر به جدولimplementations/README.mdاضافه کنید.
- الگوریتم صفحهٔ
- بررسی و تست یک کتابخانهٔ جدید: یک اسکریپت در پوشهٔ
tools/library-evaluationاضافه کنید که فایلresults/<library>_<version>.txtرو تولید کنه، بعد توی پوشهٔtools/calendar-dataدستورcargo run --release -- score-librariesرو اجرا کنید و در نهایت صفحهٔ ۶ مستندات رو آپدیت کنید. - گزارش کردن باگ به سازندگان کتابخانهها و قرار دادن لینک Issue در مستندات.
چند قانون ساده
پیوند به بخش چند قانون ساده- هر ادعا یا نکتهای دربارهٔ تقویم باید منبع معتبر داشته باشه (انتشارات رسمی مرکز تقویم دانشگاه تهران، مقالهٔ علمی، استاندارد CLDR یا کد قابل بازتولید).
- فایلهای داخل پوشهٔ
data/رو هیچوقت دستی ویرایش نکنید؛ اگر تغییری لازمه، کدtools/calendar-dataرو تغییر بدید و دادهها رو از نو بسازید (cd tools/calendar-data && cargo run --release). سرویس CI هم با دستورcargo run --release -- --checkاین موضوع رو چک میکنه. - قبل از فرستادن Pull Request، مطمئن بشید که تمام تستهای کدتون روی سیستم خودتون پاس میشن.
- در بخش تعطیلات: تعطیلات رسمی، مناسبتهای غیرتعطیل و کشورهای مختلف رو از هم جدا نگه دارید و همیشه منبع رو ذکر کنید.
- لحن فنی، مستند و بیطرفانهٔ راهنما رو حفظ کنید.