# مشارکت

ممنون که وقت می‌ذارید و کمک می‌کنید! اولویت اول این مخزن **درستی و دقت** اطلاعاته، پس برای هر تغییری لطفا یک منبع معتبر یا تست همراهش بذارید.

## چطور می‌تونید مشارکت کنید؟

- **اصلاح یا بهتر کردن مستندات**: صفحات انگلیسی (`docs/en`) و فارسی (`docs/fa`) رو هماهنگ نگه دارید. اگر فقط به یکی از دو زبان می‌نویسید، توی توضیحات Pull Request بگید تا بقیه در ترجمه‌ش کمک کنن.
- **اضافه کردن یک زبان برنامه‌نویسی جدید** به [`implementations/`](https://goudarzjafari.com/fa/persian-calendar/implementations/):
  1. الگوریتم صفحهٔ [`docs/fa/03-algorithm.md`](https://goudarzjafari.com/fa/persian-calendar/algorithm/) رو به زبان مورد نظرتون پیاده‌سازی کنید. قواعد نام‌گذاری و استایل همون زبان رو رعایت کنید، اما همین توابع استاندارد رو نگه دارید: تشخیص سال کبیسه، تعداد روزهای ماه، اعتبارسنجی تاریخ، تبدیل از/به JDN، تبدیل از/به میلادی، روز هفته (۰ = شنبه) و شمارهٔ روز در سال.
  2. یک فایل تست بنویسید که `data/years.csv` و `data/test-vectors.csv` رو بخونه، تک‌تک روزهای سال ۱۱۷۸ تا ۳۰۰۰ رو دوطرفه تبدیل و چک کنه و اعتبارسنجی ورودی‌ها رو هم تست کنه (می‌تونید از تست‌های زبان‌های دیگه الگو بگیرید).
  3. یک job به فایل [`.github/workflows/test.yml`](https://github.com/Goudarz/PersianCalendar/blob/main/.github/workflows/test.yml) و یک سطر به جدول [`implementations/README.md`](https://goudarzjafari.com/fa/persian-calendar/implementations/) اضافه کنید.
- **بررسی و تست یک کتابخانهٔ جدید**: یک اسکریپت در پوشهٔ [`tools/library-evaluation`](https://goudarzjafari.com/fa/persian-calendar/tools/library-evaluation/) اضافه کنید که فایل `results/<library>_<version>.txt` رو تولید کنه، بعد توی پوشهٔ `tools/calendar-data` دستور `cargo run --release -- score-libraries` رو اجرا کنید و در نهایت صفحهٔ ۶ مستندات رو آپدیت کنید.
- **گزارش کردن باگ به سازندگان کتابخانه‌ها** و قرار دادن لینک Issue در مستندات.

## چند قانون ساده

- هر ادعا یا نکته‌ای دربارهٔ تقویم باید منبع معتبر داشته باشه (انتشارات رسمی مرکز تقویم دانشگاه تهران، مقالهٔ علمی، استاندارد CLDR یا کد قابل بازتولید).
- فایل‌های داخل پوشهٔ `data/` رو هیچ‌وقت دستی ویرایش نکنید؛ اگر تغییری لازمه، کد [`tools/calendar-data`](https://goudarzjafari.com/fa/persian-calendar/tools/calendar-data/) رو تغییر بدید و داده‌ها رو از نو بسازید (`cd tools/calendar-data && cargo run --release`). سرویس CI هم با دستور `cargo run --release -- --check` این موضوع رو چک می‌کنه.
- قبل از فرستادن Pull Request، مطمئن بشید که تمام تست‌های کدتون روی سیستم خودتون پاس می‌شن.
- در بخش تعطیلات: تعطیلات رسمی، مناسبت‌های غیرتعطیل و کشورهای مختلف رو از هم جدا نگه دارید و همیشه منبع رو ذکر کنید.
- لحن فنی، مستند و بی‌طرفانهٔ راهنما رو حفظ کنید.

---

نشانی صفحه: https://goudarzjafari.com/fa/persian-calendar/contributing/
مجوز: متن CC BY 4.0، کد MIT، داده CC0 1.0. نسخهٔ 1.0.0 از https://github.com/Goudarz/PersianCalendar
