Руководство по представлению результатов работы

В рамках окончательной оценки все участвующие участники должны предоставить ссылку на работу, которую они проделали для программы. Несоблюдение этого требования может привести к сбою программы . Это можно сделать несколькими способами, поэтому внимательно прочтите этот документ.

Эти ссылки будут опубликованы в публичном архиве проектов GSoC . Они помогают продемонстрировать работу, проделанную во время программы. Это также отличный способ напомнить о своей работе будущим работодателям. Вы хотите, чтобы люди могли быстро понять, каковы цели вашего проекта, чего вы достигли, где находится ваш код и какие потенциальные следующие шаги.

Лучшие примеры, которые мы видели за последние годы, выглядят как «окончательный отчет», который содержит:

  • Краткое описание целей проекта.
  • Что ты сделал.
  • Текущее состояние.
  • Что осталось сделать.
  • Какой код был объединен (или нет) в исходную версию.
  • Любые проблемы или важные вещи, которые вы узнали во время проекта.

Чтобы просмотреть примеры, начните со списка проектов на 2022 год , выберите случайным образом проекты и нажмите ПРОСМОТРЕТЬ КОД. Обратите внимание, что многие из этих проектов не последовали нашим предложениям, а это означает, что им только вредит возможность продемонстрировать свою работу.

ПРИМЕЧАНИЕ ДЛЯ УЧАСТНИКА: После того как вы отправите окончательную представленную работу, вы сможете редактировать ее до истечения срока подачи окончательной работы.

Вам следует поделиться ссылкой со своим наставником ПЕРЕД отправкой оценки, чтобы убедиться, что она соответствует его ожиданиям.

Требования

  • Должно быть легко определить проделанную вами работу. (т. е. внесенные вами изменения или новый код.)
    • Когда кто-то переходит по предоставленному URL-адресу, ему должно быть ясно, какую работу вы проделали, не требуя от него дополнительных дополнительных раскопок.
  • Он должен находиться в устойчивом месте. URL-адрес не может быть изменен после отправки.
  • Кто-то другой должен иметь возможность использовать контент в цели ссылки (или на нее ссылаться), чтобы расширить вашу работу.
    • Если ваша работа выполнена на 100%, они смогут ее использовать.
    • Если ваша работа не завершена на 100%, должно быть ясно, что осталось сделать.

Хорошие примеры

Вам не обязательно выполнять все (или некоторые) из этих действий, но есть несколько способов удовлетворить требования.

  • Создайте запись в блоге, веб-страницу или общедоступный список GitHub, в котором будет описана проделанная вами работа и даны ссылки на сделанные вами коммиты и репозитории, над которыми вы работали. Если над проектом еще есть работа, включите и ее. Вы также можете поделиться яркими или сложными моментами.
    • ❗Это лучший вариант, поскольку позволяет легко включить много информации. Это хорошо, потому что это наглядно покажет, какую работу вы проделали, а также облегчит другим использование и понимание вашего кода.
  • Если вы используете GitHub и вся ваша работа покрывается одним запросом на включение, вы можете использовать эту ссылку.
    • Убедитесь, что описание запроса на извлечение подробное. (См. рекомендации по содержанию сообщений в блоге выше.)
    • Убедитесь, что в описании четко указано, что это для Google Summer of Code.
    • Если запрос на включение потребует дополнительной работы после завершения GSoC, убедитесь, что последний коммит GSoC записан.
    • ❗ Преимущество этого примера состоит в том, что журнал изменений, список коммитов и комментарии к обзору собраны в одном месте.
  • Если ваш репозиторий GitHub предназначен для GSoC, добавьте README.md с более подробной информацией.
  • Отправьте электронное письмо в общедоступный список рассылки разработчиков с указанным выше и ссылкой на него.
  • Создайте общедоступную папку на Google Диске и включите в нее все созданные вами исправления.
  • Создайте общедоступную таблицу с помощью Google Sheets и перечислите все свои коммиты.
  • Ссылка на единственную ошибку, которая явно содержит ссылки на работу и все остальное, что уместно. Он должен отслеживать всю проделанную вами работу. Убедитесь, что в нем перечислены все коммиты или их легко найти иным образом.
  • Ссылка на унифицированную или контекстную разницу ваших изменений. Обязательно включите заголовок, в котором указано, для какого проекта он предназначен и кто вы, чтобы он был полезен другим.

Плохие примеры

Не делайте этих вещей.

  • Ссылка на tarball/zip-файл, содержащий исходный код всего проекта, или на ваш рабочий каталог. (Слишком много людей делали это в прошлом, это бесполезно для людей, желающих больше узнать о том, что вы сделали.)
  • Ссылка на начало основного репозитория исходного кода проекта.
  • Ссылка на ваш клон исходного репозитория проекта.
    • Это затрудняет понимание ваших изменений, поскольку ваша работа смешана с другими.
  • Ссылка на страницу вашего проекта GSoC.
    • Мы уже знаем, что это такое. (т. е. https://summerofcode.withgoogle.com/projects/#1234567890 )

Наставники

Пожалуйста, помогите вашему участнику правильно отправить код. Важно сделать это до окончания периода подачи окончательной работы.

Проверь это…

  • Заявление соответствует вышеуказанным требованиям.
  • Код компилируется.
  • Есть документация о том, что и почему.

Идея GSoC не в том, что участники создают код — важно, чтобы код был потенциально полезен для хостингового проекта с открытым исходным кодом.