Logiciel libre : listez les licences, puis corrigez et testez
03
Vérification des licences
Listez les dépendances et lisez chaque licence avant de contribuer
Vous ouvrez le dossier d'un projet que vous prévoyez de modifier et vous voulez connaître les licences de ses dépendances avant d'envoyer une contribution. L'agent liste les fichiers, lit les textes de licence et rédige un tableau des paquets, versions et licences. Le résultat est un tableau que vous vérifiez ligne par ligne par rapport aux textes de licence, et vous corrigez ce qui est erroné. C'est un brouillon qui vous aide à poser les bonnes questions, et les fichiers du projet restent la source de vérité. Suivez les 4 étapes ci-dessous dans l'ordre, et arrêtez-vous à toute étape où quelque chose vous semble peu clair.
01
Ouvrez le dossier
Ouvrez le dossier du projet dans une nouvelle conversation et choisissez Ask first, afin que chaque modification vous soit montrée avant d'être écrite. Vérifiez que le dossier est bien celui du projet que vous pouvez modifier, et non une copie appartenant à quelqu'un d'autre. Cela prend une minute. Utilisez une nouvelle conversation pour chaque projet.
02
Listez les fichiers
Laissez list_dir et glob trouver les fichiers de dépendance et les fichiers de licence, et lisez la liste des résultats que l'agent affiche dans la conversation. Ouvrez toute carte qui semble inhabituelle, car une carte affiche le résultat complet. Rien n'est modifié à cette étape. Prenez votre temps.
03
Lisez les licences
Utilisez read_file et grep pour lire les textes de licence et les lignes SPDX, et notez tout ce que vous ne comprenez pas, afin de pouvoir demander des précisions au projet. Un code sans licence est, dans la plupart des pays, inutilisable librement. Vous lisez uniquement ici, vous ne modifiez pas les fichiers.
04
Vérifiez le résultat
Examinez le fichier CSV et le diff, puis comparez chaque ligne avec son texte de licence et lancez les tests du projet si vous avez modifié des fichiers. Acceptez uniquement ce que vous avez compris, et rejetez le reste. Ensuite, envoyez vous-même la contribution, comme le demande le projet. Conservez une copie de l'inventaire.
Exemple d'inventaire des licences dans un fichier CSV
LibrePatch · Créer l'inventaire● Ask first
Créez un inventaire CSV des dépendances et de leurs licences.
list_dir.12 éléments
globLICENSE*2 fichiers
grepSPDX3 correspondances
write_filelicenses.csvsauvegardé
edit_filelicenses.csv+1 -1
En attente de votre validation avant l'étape suivanteRejeterAccepter
Le fichier liste huit paquets d'exemple avec des noms inventés, leurs versions et leurs identifiants de licence. Remplacez les lignes par les vraies données de votre projet. Une courte note dans la dernière colonne indique ce qu'il faut conserver ou partager, et vous la vérifiez par rapport au texte de licence. Les noms, versions et licences ici sont des exemples uniquement, et un vrai inventaire a une ligne pour chaque dépendance.
Parcours : lisez les licences, ajoutez un en-tête, lancez les tests, révisez
Explorez le code et trouvez les fichiers de licence
Vous commencez avec list_dir pour voir la structure du dossier et glob pour trouver LICENSE, COPYING et les fichiers de dépendance, puis grep recherche les lignes SPDX dans les fichiers source. Le logiciel libre indique normalement sa licence à ces 3 endroits, donc la recherche montre ce que chaque fichier déclare et quels fichiers ne déclarent rien. Les mainteneurs d'une application éducative open source listent souvent les fonctionnalités souhaitées ensuite dans leurs tickets, alors lisez-les aussi avant de choisir une tâche. Lisez, ne modifiez pas. Chaque résultat est une carte que vous pouvez développer, et à la fin de cette étape vous avez une liste de fichiers et de licences à vérifier, que vous examinez attentivement avant de passer à l'étape suivante. Enregistrez vos notes dans un fichier texte afin de pouvoir y revenir plus tard.
Lisez la licence et les règles de contribution
Maintenant read_file ouvre le fichier LICENSE et le fichier CONTRIBUTING. La licence vous indique ce que vous pouvez faire avec le code, et les règles de contribution vous indiquent comment le projet souhaite que les modifications soient envoyées, alors lisez-les entièrement. Votre première contribution open source sera plus facile à accepter si elle respecte exactement ces règles, alors notez-les. Certains contributeurs demandent s'il faut partager l'historique de leur session de codage IA dans le travail open source ; la politique du projet sur les modifications assistées par IA répond à cette question, et elle peut vous demander de dire qu'un outil a aidé. Lancez les tests du projet une fois avant de modifier quoi que ce soit, afin de connaître le résultat de départ. Ensuite, révisez vos notes et notez les règles qui s'appliquent à votre modification. Lisez aussi le code de conduite si le projet en a un, car il indique le comportement attendu.
Ajoutez l'en-tête demandé par le projet
Certains projets exigent un court en-tête de licence, par exemple une ligne SPDX, en haut de chaque nouveau fichier. Uniquement lorsque le fichier CONTRIBUTING ou le LICENSE le précise, vous utilisez edit_file pour ajouter exactement cet en-tête à vos 3 nouveaux fichiers, et dans Ask first l'agent montre un diff avant que quoi que ce soit ne soit écrit. Conservez chaque avis de copyright existant et ne modifiez jamais une licence. Révisez le diff ligne par ligne. Ensuite, utilisez grep pour lister les fichiers qui n'ont toujours pas l'en-tête et lancez la commande de test du projet, car le code de sortie vous indique si la commande s'est terminée sans erreur. Si un test échoue, lisez la sortie avant de modifier autre chose, et demandez au projet quand une règle d'en-tête est peu claire. Utilisez la même ligne d'en-tête dans chaque fichier.
Vérifiez le résultat avant de l'envoyer
Enfin grep montre quels fichiers n'ont pas l'en-tête, Shell relance les tests et rapporte le code de sortie, et vous lisez à nouveau tout le diff. Ce sont 3 résultats à comparer. Une commande de scanner de vulnérabilités de code source que vous fournissez peut aussi s'exécuter via Shell ; l'agent affiche sa sortie et vous décidez de ce qu'elle signifie, mais ni l'analyse ni l'agent ne garantissent qu'il n'y ait rien d'autre de faux. Rédigez la description de la pull request, mentionnez la licence que vous avez vérifiée et les tests que vous avez lancés, et envoyez-la vous-même. Suivez les règles du projet. Les relecteurs peuvent demander des modifications, et vous y répondez de la même manière : une petite étape, un diff, un test. Attendez leur réponse avant de modifier davantage. Remerciez le relecteur quand il vous aide, et gardez chaque réponse courte et polie, une correction à la fois.