هدف این مخزن، جمع‌آوری و به روز نگه‌داشتن رویدادهای مهم در تقویم کشورهای پارسی زبان است.
معیار اینکه یک رویداد مهم است یا نیست و باید اینجا اضافه شود یا نه، ویکی‌پدیاست. ما تنها این رویدادها را جمع‌آوری میکنیم، تعیین اینکه آیا یک رویداد به اندازه کافی سرشناس هست که به این مخزن اضافه شود یا نه برمبنای ویکی‌پدیاست، نه تصمیم شخصی یا گروهی افرادی که این مخزن را مدیریت میکنند.
برای افزودن یک رویداد یا اصلاح یک رویداد موجود میتوانید یا یک گزارش اشکال پر کنید یا که یک درخواست ادغام ایجاد کنید.
فایلهای موجود در پوشه docs را برای توضیح ساختار ببینید
فایلهای موجود در برنچ master برای استفاده در برنامه شما نیست. فایلهای نتیجه در برنچ gh-pages هستند و فایلهای برنچ مستر سورس فایل نهایی ساخته شده در برنچ gh-pages است. اگر شما می‌خواهید که از این رویدادها استفاده کنید، لطفا این برنچ را ببینید.[1]
در حال حاضر فرمتهای «خروجی» پشتیبانی شده yaml و json هستند. اگر فرمت دیگری مدنظر شماست میتوانید آن‌را به ابزار ما اضافه کنید (این ابزار با Go نوشته شده است) یا اگر نمی‌توانید یک درخواست جدید ایجاد کنید.
برای ورودی اطلاعات (و نه خروجی)ما yaml را انتخاب کردیم به دلایل زیر :
- این فرمت در مقایسه با
jsonیاxmlبرای افراد غیر برنامه‌نویس (کسانی که کامپیوتری نیستند) خواناتر است - فرمت
jsonرا میتوان به هر صورتی نوشت. برای برنامه، چندان فرقی نمیکند، ولی برای فایلی که قرار است توسط انسان نگهداری شود مناسب نیست. در صورتی کهyamlحتی تو رفتگی را هم اجبار میکند - در نهایت اینکه این ساختار در خروجی تاثیری ندارد و در خروجی همچنان همه فرمتهایی که لازم هستند ایجاد میشوند
[1] به زودی با کمک قابلیت انتشار گیت‌هاب، یک وب سایت استاتیک با لینک دانلود برای رویدادها ایجاد میشود.