دستورالعمل ارسال محصول کار

به عنوان بخشی از ارزیابی نهایی، همه مشارکت کنندگان شرکت کننده باید پیوندی به کاری که برای برنامه انجام داده اند ارائه دهند. عدم انجام صحیح این کار ممکن است منجر به از کار افتادن برنامه شود . راه های مختلفی برای انجام این کار وجود دارد، بنابراین لطفاً این سند را با دقت بخوانید.

این پیوندها در آرشیو عمومی پروژه های GSoC منتشر خواهند شد. آنها به نشان دادن کاری که در طول برنامه انجام شده است کمک می کنند. آنها همچنین یک راه عالی برای شما هستند تا به کار خود برای کارفرمایان آینده مراجعه کنید. شما می خواهید که مردم بتوانند به سرعت متوجه شوند که اهداف پروژه شما چه بوده است، چه کارهایی انجام داده اید، کد شما کجاست و هر مرحله احتمالی بعدی.

بهترین نمونه‌هایی که در سال‌های گذشته دیده‌ایم، شبیه یک «گزارش نهایی» هستند که شامل:

  • شرح مختصری از اهداف پروژه.
  • چه کار کردی.
  • وضعیت فعلی.
  • چه کاری باقی مانده است.
  • کدهایی که در بالادست ادغام شدند (یا نه).
  • هر چالش یا چیز مهمی که در طول پروژه یاد گرفتید.

برای مشاهده نمونه‌ها، از فهرست پروژه‌های 2022 شروع کنید، پروژه‌ها را به‌طور تصادفی انتخاب کنید و سپس روی VIEW CODE کلیک کنید. لطفاً توجه داشته باشید که بسیاری از این پروژه‌ها از پیشنهادات ما پیروی نکردند، که به این معنی است که فقط به آنها آسیب می‌زند که بتوانند کار خود را به نمایش بگذارند.

توجه به مشارکت کننده: پس از ارسال اثر نهایی خود، می توانید آن را تا آخرین مهلت ارسال کار خود ویرایش کنید.

قبل از ارسال ارزیابی خود باید پیوند خود را با مربی خود به اشتراک بگذارید تا مطمئن شوید که انتظارات آنها را برآورده می کند.

الزامات

  • شناسایی کاری که انجام داده اید باید آسان باشد. (یعنی تغییراتی که ایجاد کردید یا کد جدید.)
    • هنگامی که شخصی به URL ارائه شده مراجعه می کند، باید مشخص باشد که شما چه کاری انجام داده اید بدون اینکه از او بخواهید حفاری بیشتری انجام دهد.
  • باید در یک مکان ثابت باشد. آدرس اینترنتی پس از ارسال قابل تغییر نیست.
  • شخص دیگری باید بتواند از محتوا در هدف پیوند (یا ارجاع شده از آن) برای گسترش کار شما استفاده کند.
    • اگر کار شما 100% کامل است، آنها باید بتوانند از آن استفاده کنند.
    • اگر کار شما 100% کامل نشده است، باید مشخص باشد که چه کاری باقی مانده است.

نمونه های خوب

شما مجبور نیستید همه (یا هیچ کدام) از این کارها را انجام دهید، اما اینها راه هایی هستند که می توانید الزامات را برآورده کنید.

  • یک پست وبلاگ یا صفحه وب یا کلیات GitHub عمومی ایجاد کنید که کارهایی را که انجام داده اید توصیف می کند و به تعهداتی که انجام داده اید و مخازنی که روی آنها کار کرده اید پیوند می دهد. اگر هنوز کاری برای انجام پروژه وجود دارد، آن را نیز درج کنید. همچنین می توانید نکات برجسته یا قطعات چالش برانگیز را به اشتراک بگذارید.
    • ❗ این بهترین گزینه است زیرا به شما امکان می دهد اطلاعات زیادی را به راحتی درج کنید. این خوب است زیرا به وضوح نشان می دهد که چه کاری انجام داده اید، و همچنین استفاده و درک کد شما را برای دیگران آسان می کند.
  • اگر از GitHub استفاده می کنید و تمام کارهای شما با یک درخواست کشش پوشش داده می شود، می توانید از آن پیوند استفاده کنید.
    • اطمینان حاصل کنید که توضیحات درخواست کشش دقیق است. (به پیشنهادات برای محتوای پست وبلاگ در بالا مراجعه کنید.)
    • مطمئن شوید که توضیحات به وضوح به این نکته اشاره می‌کند که این برای Google Summer of Code است.
    • اگر قرار است پس از پایان GSoC، درخواست کشش کارهای بیشتری انجام شود، مطمئن شوید که آخرین تعهد GSoC ذکر شده است.
    • ❗ این مثال دارای مزایای ثبت تغییرات، لیستی از commit ها و نظرات بررسی همه در یک مکان است.
  • اگر مخزن GitHub شما برای GSoC تک منظوره است، یک README.md با جزئیات بیشتر اضافه کنید.
  • یک ایمیل به لیست پستی توسعه دهندگان بایگانی شده عمومی با موارد بالا ارسال کنید و به آن نیز پیوند دهید.
  • یک پوشه عمومی در Google Drive ایجاد کنید و همه وصله‌هایی که ایجاد کرده‌اید را در آن قرار دهید.
  • با Google Sheets یک صفحه گسترده عمومی ایجاد کنید و تمام تعهدات خود را فهرست کنید.
  • پیوند به یک باگ که به وضوح حاوی ارجاع به کار و هر چیز مناسب دیگری است. باید تمام کارهایی را که انجام داده اید ردیابی کند. مطمئن شوید که تمام تعهدات را فهرست می کند یا در غیر این صورت یافتن آنها آسان است.
  • به یک تفاوت یکپارچه یا زمینه تغییرات خود پیوند دهید. حتماً یک هدر اضافه کنید که یادداشت کند برای چه پروژه ای است و شما چه کسی هستید، بنابراین برای دیگران مفید است.

مثال های بد

این کارها را نکن

  • پیوند به tarball/zipfile حاوی کد منبع کل پروژه یا دایرکتوری کاری شما. (افراد زیادی این کار را انجام داده‌اند، این کار برای افرادی که می‌خواهند بیشتر در مورد کاری که شما انجام داده‌اید بفهمند مفید نیست.)
  • به بالای مخزن منبع اصلی پروژه پیوند دهید.
  • به کلون خود از مخزن منبع پروژه پیوند دهید.
    • این باعث می شود که دیدن تغییرات شما دشوار باشد زیرا کارهای شما با دیگران مخلوط شده است.
  • به صفحه پروژه GSoC خود پیوند دهید.
    • ما قبلاً می دانیم که چیست. (یعنی https://summerofcode.withgoogle.com/projects/#1234567890 )

مربیان

لطفاً به مشارکت کننده خود کمک کنید تا کد را به درستی ارسال کند. انجام این کار قبل از دوره نهایی ارسال کار بسیار مهم است.

بررسی کنید که…

  • ارسالی الزامات فوق را برآورده می کند.
  • کد کامپایل می شود.
  • مستنداتی از چیستی و چرایی آن وجود دارد.

ایده GSoC این نیست که مشارکت کنندگان کد تولید کنند - مهم این است که کد به طور بالقوه برای میزبانی پروژه منبع باز مفید باشد.