Consignes d'envoi des produits Work

Lors de l'évaluation finale, tous les contributeurs participants doivent fournir un lien vers le travail qu'ils ont effectué pour le programme. Si vous ne le faites pas correctement, le programme risque d'échouer. Pour ce faire, vous disposez de plusieurs méthodes. Veuillez lire attentivement ce document.

Ces liens seront publiés dans les archives publiques des projets GSoC. Ils aident à démontrer le travail effectué pendant le programme. Ils sont également un excellent moyen pour vous de vous référer à votre travail pour de futurs employeurs. Vous devez faire en sorte que les utilisateurs comprennent rapidement les objectifs de votre projet, ce que vous avez accompli, où se trouve votre code et les prochaines étapes potentielles.

Les meilleurs exemples que nous avons vus au cours des années précédentes ressemblent à un "rapport final" qui contient les éléments suivants:

  • Brève description des objectifs du projet.
  • Ce que vous avez fait.
  • État actuel.
  • Il reste à faire.
  • Le code qui a été fusionné (ou non) en amont.
  • Tous les défis ou choses importantes que vous avez appris au cours du projet.

Pour consulter des exemples, accédez à la liste des projets 2022, sélectionnez des projets au hasard, puis cliquez sur AFFICHER LE CODE. Veuillez noter qu'un grand nombre de ces projets n'ont pas suivi nos suggestions, ce qui ne leur fait que nuire à la présentation de leur travail.

REMARQUE AUX CONTRIBUTEURS: Une fois que vous avez envoyé votre travail final, vous pouvez le modifier jusqu'à la date limite.

Vous devez partager votre lien avec votre mentor AVANT de soumettre votre évaluation pour vous assurer qu'elle répond à ses attentes.

Conditions requises

  • Il doit être facile d’identifier le travail que vous avez effectué. (c'est-à-dire les modifications que vous avez apportées ou le nouveau code).
    • Lorsqu'un utilisateur accède à l'URL fournie, le travail que vous avez effectué doit être clairement indiqué, sans qu'il soit nécessaire d'y effectuer d'importants recherches supplémentaires.
  • Elle doit se trouver dans un endroit stable. Une fois envoyée, l'URL ne peut plus être modifiée.
  • Quelqu'un d'autre doit pouvoir utiliser le contenu disponible à la cible du lien (ou référencé à partir de) pour étendre votre travail.
    • Si votre travail est terminé à 100 %, il devrait pouvoir l’utiliser.
    • Si votre travail n'est pas terminé à 100 %, vous devez indiquer clairement ce qu'il vous reste à faire.

À faire

Vous n'avez pas besoin d'effectuer toutes ces opérations, mais il s'agit là de quelques façons de répondre aux exigences.

  • Créez un article de blog, une page Web ou un Gist GitHub public qui décrit le travail que vous avez effectué et renvoie vers les commits que vous avez effectués et les dépôts sur lesquels vous avez travaillé. S'il reste du travail à effectuer sur le projet, incluez-le également. Vous pouvez également partager les temps forts ou les difficultés.
    • ❗ C'est la meilleure option, car elle vous permet d'inclure facilement de nombreuses informations. Cette approche est utile, car elle indique clairement le travail que vous avez effectué, et facilite l'utilisation et la compréhension de votre code.
  • Si vous utilisez GitHub et que l'ensemble de votre travail est couvert par une seule demande d'extraction, vous pouvez utiliser ce lien.
    • Assurez-vous que la description de la demande d'extraction est détaillée. (voir les suggestions concernant le contenu des articles de blog ci-dessus.)
    • Assurez-vous que la description indique clairement qu'il s'agit de Google Summer of Code.
    • Si la demande d'extraction nécessite davantage de travail une fois le GSoC terminé, assurez-vous de noter le dernier commit du GSoC.
    • ❗ Cet exemple présente l'avantage de regrouper le journal des modifications, la liste des commits et les commentaires des avis au même endroit.
  • Si votre dépôt GitHub a une seule fonction pour le GSoC, ajoutez un fichier README.md plus en détail.
  • Envoyez un e-mail à la liste de diffusion des développeurs archivée publiquement avec ce qui précède, ainsi qu'un lien vers celle-ci.
  • Créez un dossier public dans Google Drive contenant tous les correctifs que vous avez créés.
  • Créez une feuille de calcul publique avec Google Sheets et répertoriez tous vos commits.
  • Ajoutez un lien vers un bug unique qui contient clairement des références au travail et tout autre élément approprié. Il devrait suivre tout le travail que vous avez effectué. Assurez-vous qu'il répertorie tous les commits ou qu'il est facile de les trouver.
  • Créez un lien vers une comparaison unifiée ou contextuelle de vos modifications. Veillez à inclure un en-tête indiquant à quel projet il est destiné et qui vous êtes, afin qu'il soit utile aux autres.

À ne pas faire

Ne faites pas ces choses.

  • Lien vers un fichier tarball/zip contenant le code source de l'ensemble du projet ou votre répertoire de travail. (Trop de gens l'ont fait par le passé. Cela n'est donc pas utile pour ceux qui souhaitent en savoir plus sur vous.)
  • Lien vers la partie supérieure du dépôt source principal du projet.
  • Lien vers votre clone du dépôt source du projet.
    • Il est donc difficile de voir quelles modifications sont effectuées, car votre travail est mélangé à d'autres.
  • Lien vers la page de votre projet GSoC.
    • Nous savons déjà de quoi il s'agit (par exemple, https://summerofcode.withgoogle.com/projects/#1234567890).

Parrains

Veuillez aider votre contributeur à envoyer le code correctement. Il est important de procéder à cette opération avant la période d'envoi finale des travaux.

Vérifiez que...

  • L'envoi respecte les conditions ci-dessus.
  • Le code est compilé.
  • Il existe une documentation qui explique quoi et pourquoi.

L'idée du GSoC n'est pas que les contributeurs abandonnent du code. Il est important que ce code soit potentiellement utile au projet Open Source d'hébergement.