Préserver et rendre identifiables les logiciels de recherche avec Software Heritage

[marie-flesch]

Programming Historian en français a reçu une proposition de leçon originale intitulée "Préserver et rendre identifiables les logiciels de recherche avec Software Heritage", de la part de Sabrina Granger, Baptiste Mélès et Frederic Santos.

Cette leçon a trois objectifs pédagogiques principaux :

1. Comprendre les enjeux de l'archivage du code source des logiciels de recherche, et ses spécificités par rapport aux jeux de données.
2. Archiver des logiciels, qu'ils soient écrits par vous-même ou par un.e collègue.
3. Comprendre les différents besoins d'identification inhérents au logiciel. Obtenir et utiliser des identidiants intrinsèques pour une meilleure reproductibilité de ses travaux.

La proposition a été évaluée et acceptée par l'équipe de Programming Historian en français. Elle répond à nos critères en termes de science ouverte et de pérennité.

La leçon sera envoyée par ses auteurices fin mai 2024. À sa réception, son suivi éditorial sera confié à un·e des membres de l'équipe de Programming Historian en français.

Si nous n'avons pas reçu la leçon à la date convenue, nous contacterons ses auteurices. En cas de non-réponse, nous fermerons ce ticket.

Programming Historian en français a pour but d'offrir un environnement académique ouvert, qui permet aux membres de la communauté de se sentir libres d'examiner des idées en détail, de poser des questions, de faire des suggestions, ou de formuler des demandes de clarification. Nous insistons sur l'importance de faire en sorte que cet espace de discussion reste respectueux et exempt de tout harcèlement pour tous les contributeur(trice)s, quels que soient leur genre, leur identité et leur expression de genre, leur orientation sexuelle, leur handicap, leur apparence physique, leur masse corporelle, leurs origines, leur âge, leur religion, ou leur expérience technique. Nous ne tolérons pas, sous quelque forme que ce soit, le harcèlement ou les attaques ad hominem contre les membres de la communauté. Les participant·es qui violeraient ces règles pourront être exclu·es de la communauté à la discrétion du comité éditorial. Si quelqu'un est témoin ou pense avoir été victime des agissements décrits plus haut, veuillez prendre contact avec notre médiatrice Hélène Huet. Merci de nous aider à créer un espace de discussion et d'échange sûr. Contacter notre médiatrice n'a aucun impact sur l'issue du processus d'évaluation par les pairs.

[marie-flesch]

Nous avons reçu la leçon, et @DMathelier s'est proposée pour en assurer le suivi ✨

[marie-flesch]

Les auteurices de la leçon sont @sabrinagranger, @BapMel et @frederic-santos.

[charlottejmc]

Bonjour @DMathelier, @sabrinagranger, @BapMel et @frederic-santos,

Vous trouverez les fichiers ici :

• .md: /fr/en-cours/originales/preserver-logiciels-recherche.md
• images: /images/preserver-logiciels-recherche
• assets: /assets/preserver-logiciels-recherche

Vous pouvez parcourir l’aperçu de la soumission ici :

• http://programminghistorian.github.io/ph-submissions/fr/en-cours/originales/preserver-logiciels-recherche

---

• [x] I noticed that the file for Figure 5 citar_GitHub.png was not included in the image folder, which only contained citar_GitHub_raw.png. Would you like me to use this one? If not, could you please send the image to my address publishing.assistant[@]programminghistorian.org? Merci !
• [x] I have added a field to the liquid syntax for our images: alt="Visual description of figure image".

This descriptive element enables screen readers to read the information conveyed in the images for people with visual impairments, different learning abilities, or who cannot otherwise view them, for example due to a slow internet connection. It's important to say that alt-text should go further than repeating the figure captions.

We have found Amy Cesal's guide to Writing Alt Text for Data Visualization useful. This guide advises that alt-text for graphs and data visualisations should consist of the following:

alt="[Chart type] of [data type] where [reason for including chart]"

What Amy Cesal's guide achieves is prompting an author to reflect on their reasons for including the graph or visualisation. What idea does this support? What can a reader learn or understand from this visual?

The Graphs section of Diagram Center's guidance is also useful. Some key points (relevant to all graph types) we can take away from it are:

• Briefly describe the graph and give a summary if one is immediately apparent
• Provide any titles and axis labels
• It is not necessary to describe the visual attributes of the graph (colour, shading, line-style etc.) unless there is an explicit need
• Often, data shown in a graph can be converted into accessible tables

For general images, Harvard's guidance notes some useful ideas. A key point is to keep descriptions simple, and adapt them to the context and purpose for which the image is being included.

Would you feel comfortable making a first draft of the alt-text for each of the figures? This is certainly a bit time-consuming, but we believe it is very worthwhile in terms of making your lesson accessible to the broadest possible audience.

Merci !

[anisa-hawes]

Bonjour Sabrina @sabrinagranger, Baptiste @BapMel, and Frédéric @frederic-santos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 2: Initial Edit.

In this phase, your editor Daphné @DMathelier will read your lesson, and provide some initial feedback. Daphné will post feedback and suggestions as a comment in this issue, so that you can revise your draft in the following phase (Phase 3: Revision 1).

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#3d7c81', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 1 <br> Submission
Who worked on this? : Publishing Assistant (@charlottejmc) 
All  Phase 1 tasks completed? : Yes
Section Phase 2 <br> Initial Edit
Who's working on this? : Editor (@DMathelier)  
Expected completion date? : July 14
Section Phase 3 <br> Revision 1
Who's responsible? : Authors (@sabrinagranger, @BapMel, @frederic-santos) 
Expected timeframe? : ~30 days after feedback is received

In the meantime, I've sent you each an invitation to join us as Outside Collaborators here on GitHub. This will give you the 'write access' you'll need to edit your alt-text as Charlotte suggests above. Your lesson file is here: /fr/en-cours/originales/preserver-logiciels-recherche.md, and you can edit it directly.

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

[frederic-santos]

Bonjour à toute l'équipe PH : @DMathelier, @anisa-hawes, @marie-flesch et @charlottejmc !

Je viens de pousser un nouveau commit qui devrait résoudre (j'espère !) vos commentaires et suggestions ci-dessus. Merci pour votre première relecture !

• Pour la Fig. 5, il s'agissait bien du fichier citar_GitHub_raw.png : mes excuses.

• Étant donné que presque toutes nos images sont des gifs animés dont la description textuelle précise n'est pas évidente, j'ai fait au mieux pour les balises alt-text. Lorsque cela était possible, j'ai essayé d'être assez spécifique en peu de mots. Parfois, c'était difficile de décrire précisément les manipulations montrées sur le gif, et je suis donc resté plus évasif. J'espère que cela correspondra quand même à peu près à ce que vous attendiez.

Of course, mes co-auteurs @sabrinagranger et @BapMel peuvent également m'engueuler si ce n'est pas le cas ;)

À bientôt et merci !

[DMathelier]

Bonjour Sabrina @sabrinagranger, Baptiste @BapMel, and Frédéric @frederic-santos,

J’ai fini de relire votre leçon, un grand merci pour votre travail très utile !

Avant que nous passions à la phase d’évaluation j’ai des remarques et améliorations à vous proposer. Désolée d’avance pour le pavé mais il s’agit des corrections habituelles et vous êtes libres de ne pas toutes les accepter évidemment :)

Interrogations

• [x] @BapMel §6 : que signifie la « demi-durée de vie » ? see: https://github.com/programminghistorian/ph-submissions/issues/616#issuecomment-2232843835

Propositions de correction

• §7 : Leurs conditions d’utilisation peuvent être modifiées, de sorte que les espaces de travail fonctionnant avec une technologie donnée ne soient plus maintenus → Leurs conditions d’utilisation peuvent être modifiées et les espaces de travail fonctionnant avec une technologie donnée ne seraient alors plus maintenus

• [X] §21 et §43 : remplacer le point d’interrogation à la fin du paragraphe par un point.

• [X] § 24 : revoir la formulation du commencement de la liste (+ ajout de majuscules en début de ligne et de points en fin de chaque ligne)

Software Heritage fournit aussi :
- Des contenus publics [...] Google Code.
- Des contenus des forges [...] dans l’archive.
- Des codes sources associés [...] et technologies.
- Des codes sources de logiciels [...] publiés ou non.

• [X] §28 : chaque modification peut être documentée via une révision, ou commit en anglais → chaque modification peut être documentée à l’aide d’une « révision » (*commit*)

• [X] §38 : Orcid → ORCID

• [X] §40 : commencer la citation par numéro (supprimer C’est un)

• [name=sabrina] a ajouté une majuscule en début de citation

• [X] §41 : remplacer un des ayant pour éviter le recours à ce mot deux fois sur deux lignes consécutives

• [X] §45 : agencement du tableau à revoir

  • Ajouter une colonne à gauche avec les intitulés suivants (un par ligne) : Objectif, Nécessité (ou Besoin, Prérequis, etc.), Type d’identifiant, Analogie, Obtention de l’identifiant

• [name=sabrina]: changement effectué 2024-07-10

• §49 : cas présent → cas présent

• [X] @BapMel: §51 et suivants (pour chaque cas d’étude) : remplacer chaque puce par un paragraphe ? (Il me semble que cela favoriserait la lisibilité de l’ensemble)

1. Si vous ne connaissez que le _nom du projet_, par exemple «&nbsp;Linux&nbsp;», le plus simple est de chercher son dépôt officiel dans un moteur de recherche ou un catalogue de logiciels (ex. [catalogue des logiciels du MédiaLab de SciencesPo](https://medialab.sciencespo.fr/outils/)). Par exemple, en tapant «&nbsp;Linux source code&nbsp;» dans un moteur de recherche, vous tomberez assez rapidement sur une page intitulée «&nbsp;GitHub - torvalds/linux: Linux kernel source tree&nbsp;» à l’adresse <https://github.com/torvalds/linux>. Cette adresse est celle de l’«&nbsp;origine&nbsp;», c’est-à-dire du dépôt distant de référence. Elle permet de retrouver très facilement le code source sur Software Heritage, comme vous le verrez dans le point 4 ci-dessous.

Remplacer par

##### Option 1. Vous ne connaissez que le _nom du projet_

Le plus simple est de chercher son dépôt officiel dans un moteur de recherche ou un catalogue de logiciels (ex. [catalogue des logiciels du MédiaLab de SciencesPo](https://medialab.sciencespo.fr/outils/)). 

Par exemple, en tapant «&nbsp;Linux source code&nbsp;» dans un moteur de recherche, vous tomberez assez rapidement sur une page intitulée «&nbsp;GitHub - torvalds/linux: Linux kernel source tree&nbsp;» à l’adresse <https://github.com/torvalds/linux>. Cette adresse est celle de l’«&nbsp;origine&nbsp;», c’est-à-dire du dépôt distant de référence. Elle permet de retrouver très facilement le code source sur Software Heritage (comme vous le verrez dans le point 4 ci-dessous).

• [X] §56 : ajouter une virgule après le 2e tiret d’incise : fichiers —, obtenir

• [X] §63 : hyperliens seulement sur package R {tm} et sur fichier src/scan.c

• [X] §66 : pourpermettre → pour permettre

• [X] §75 : préciser le nom de l’extension ?

  • Notons qu’une extension de navigateur, [UpdateSWH](https://www.softwareheritage.org/browser-extensions/), disponible

• [X] §76 : la fig. 5 n’apparaît pas. Un problème de lien peut-être ?

• [X] §90 : supprimer le lien actuel sur README et ajouter une note plutôt (ou une précision entre parenthèses)

  • Ajouter ce lien sur README : https://www.makeareadme.com
  • Ajouter une note ou entre parenthèses : (voir par exemple le fichier README dupackage tapas

• [X] §93 : Les métadonnées intrinsèques : elles fournissent → Les métadonnées intrinsèques fournissent

• [X] §94 : remplacer le point d’interrogation par un point.

• [X] §94 : supprimer l’hyperlien sur catalogues qui renvoie à un exemple précis. Pour évoquer cet exemple, préférer une précision entre parathèse ou une note.

• [X] §104 : supprimer les : après Exercice

• [ ] §107 : supprimer le 2e Exercice et commencer le nouveau paragraphe par Pour terminer

• [x] §109 : proposer une conclusion plutôt qu’un résumé ? [name=sabrina] @frederic-santos @BapMel : svp, avant le 22/07, pourriez-vous jeter un oeil à cette proposition, volontairement pas insérée dans le texte? https://hedgedoc.softwareheritage.org/conclusion-PH#

• [X] §111 : fusionner les deux premières puces

  • Pour toute demande relative à Software Heritage, consulter la foire aux questions ou utiliser le formulaire de contact.

• [X] §111 : reformuler la dernière puce

  • Pour suivre l’actualité de Software Heritage, consulter le blog dédié ou inscrivez-vous à sa newsletter

Hyperliens

• En règle générale : privilégier les notes pour les précisions et les exemples, et les hyperliens pour les liens directs à un objet cité (exemple, ressource, outil...)
  • Ex. §90
• Réduire la taille des hyperliens (sur 2/3 mots max)
  • Ex. § 22 : hyperlien sur documentation uniquement
  • Ex. § 44 : hyperlien sur documentation technique uniquement (ou sur types de SWIDS disponibles éventuellement)
  • Ex. §94 : hyperlien sur formulaire de saisie uniquement
• Le lien du paragraphe 2 ne semble pas fonctionner.

En règle générale, corrections typographiques

• Supprimer les virgules superflues devant les conjonctions de coordinations (surtout : mais, ou, et)
  • , et → et | , ou → ou
  • Ex. §22 `sans créer de compte et il n’est pas nécessaire
• ~Mettre des apostrophes françaises partout : ’ → ’~
• ~Mettre des guillemets français : « et »~
• Dans les listes
  • Mettre des majuscules à chaque ligne
  • Mettre des points ou des points-virgules à la fin de chaque ligne (surtout s’il s’agit de phrases complètes)
  • Ex. § 31, §32
• Unifier : par exemple ou ex. (mais pas les deux)
• Pour les légendes des figures, remplacer les : par un point
  • Figure 1 : Tous → Figure 1. Tous

Suite à cette première relecture, vous avez environ un mois pour intégrer les corrections proposées, donc disons idéalement jusqu’au lundi 22 juillet ? Pendant ce temps je vais rechercher les deux expert(e)s qui évalueront votre leçon lorsque celle-ci aura été modifiée.

Bon courage et n’hésitez pas demander des précisions sur ce ticket si besoin !

[marie-flesch]

Merci @DMathelier pour cette première relecture ! @frederic-santos, @BapMel et @sabrinagranger , en fait pas besoin de vous occuper des apostrophes et des guillemets, on va le faire nous-mêmes :) Pour les autres propositions, nous vous laissons appliquer celles qui vous semblent pertinentes.

[frederic-santos]

Bonjour Marie @marie-flesch et Daphné @DMathelier,

Nom d'un pingouin, quelle efficacité ! Merci beaucoup pour cette relecture attentive et ces corrections ! Je viens de pousser quelques commits qui en implémentent déjà une bonne partie ; nous allons discuter avec mes co-auteurs pour corriger le reste dans la quinzaine à venir.

J'ai juste deux remarques/questions techniques de mon côté :

Le lien du paragraphe 2 ne semble pas fonctionner.

Théoriquement, il fonctionnera sur le site "réel" de PH (je pense ?). C'est un lien relatif vers une autre leçon hébergée sur PH, et je crois justement que les instructions aux auteurs recommandaient de donner un lien relatif plutôt qu'un lien absolu si vous voulait faire référence à une autre leçon. Est-ce toujours le cas ?

§76 : la fig. 5 n’apparaît pas. Un problème de lien peut-être ?

Oui, c'est lié à la remarque faite par Charlotte plus haut. Nous avons fait une boulette dans la version initiale de l'article, en insérant pour la Figure 5 un lien vers un fichier citar_GitHub.png, alors que le PNG que nous avons transmis s'appelait en réalité citar_GitHub_raw.png. J'ai tenté de corriger ça de mon côté, mais visiblement, pas de la bonne manière. 😀

Merci en tout cas, nous vous préviendrons quand tout sera corrigé !

[charlottejmc]

Bonjour @frederic-santos et @DMathelier,

En effet, j'attendais juste une confirmation avant d'insérer le bon lien vers la Figure 5. C'est donc bon maintenant, merci !

Je me chargerai en Phase 6 des corrections typographiques (guillemets, apostrophes, etc.). Ceci fait partie du travail que faisons @anisa-hawes et moi pendant la phase de "typesetting", et qui assure l'uniformité visuelle de nos leçons à travers les quatre langues. Ne vous inquiétez donc pas trop pour la forme !

Un certain nombre de points relevés par @DMathelier sont en fait dûs à des changements que j'ai faits moi-même en créant le fichier ! Par exemple, la forme des listes – dans nos consignes, nous demandons à ce qu'on n'utilise pas de ponctuation (points virgules, point final) à la fin de chaque ligne. Je les ai donc retirés du texte original soumis par les auteurs.

Merci ✨

[anisa-hawes]

Bonjour Sabrina @sabrinagranger, Baptiste @BapMel, and Frédéric @frederic-santos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 3: Revision 1.

This phase is an opportunity for you to revise your draft in response to @DMathelier's initial feedback. As @marie-flesch explains, @charlottejmc and I take care of all typographical adjustments as part of Phase 6 Sustainability + Accessibility. This ensures that all lessons are presented consistently across our four journals. Thank you for your understanding ☺️

I've checked to ensure that you have the 'write access' you'll need to edit your draft directly. (Baptiste @BapMel, I have sent you an invitation to join us as an Outside Collaborator, but I note that it is still pending. Please let me know if you have any difficulties gaining access.)

We ask authors to work on their own files with direct commits: we prefer you don't fork our repo, or use the Pull Request system to edit in ph-submissions. You can make direct commits to your file here: /fr/en-cours/originales/preserver-logiciels-recherche.md. @charlottejmc and I can help if you encounter any practical problems!

When you and Daphné are all happy with the revised draft, we will move forward to Phase 4: Open Peer Review.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#3d7c81', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 2 <br> Initial Edit
Who worked on this? : Editor (@DMathelier) 
All  Phase 2 tasks completed? : Yes
Section Phase 3 <br> Revision 1
Who's working on this? : Authors (@sabrinagranger, @BapMel, @frederic-santos)  
Expected completion date? : July 22
Section Phase 4 <br> Open Peer Review
Who's responsible? : Reviewers (TBC) 
Expected timeframe? : ~60 days after request is accepted

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

[sabrinagranger]

@frederic-santos : mille mercis pour les modifications apportées! j'ai refait un tour (notamment pour modifier le tableau (§45 : agencement du tableau à revoir) comme demandé mais j'ai reçu des messages d'erreur. Stp, pourrais-tu vérifier si tout est ok?

[anisa-hawes]

Bonjour Sabrina @sabrinagranger,

I hope you're well. Thank you for your work on these revisions!

In your note above, you mention receiving error messages. Do you mean an error when you are making a commit to the ph-submissions repository?

I just wanted to clarify that when we make several commits in quick succession, our previous build-checks are automatically cancelled (then show with a red cross). But this doesn't mean that there has been a problem with your commit, and indeed we can be confident that everything is well in this case because your subsequent and most recent commits have been successful.

@charlottejmc and I are here to help with any practical questions about working with Markdown or the particulars of our repository. Please let us know if we can lend a hand! ☺️

[sabrinagranger]

Hello @anisa-hawes! Thanks for your super fast support. :) Here is what I got:

[sabrinagranger]

I received these notifications after my commits

[anisa-hawes]

No problem @sabrinagranger. Yes, exactly. These notifications are only to let you know that the build checks have been skipped or cancelled because you made another commit before they had completed. Nothing to worry about here - the build checks have automatically cancelled because they have been interrupted.

Reviewing the commit log, we can review any build issues. You can be assured that everything is fine because your most recent commits have completed in full and been successful:

[sabrinagranger]

Hello @frederic-santos et @BapMel time flies ... et la période estivale n'est pas la meilleure amie du travail collaboratif. @BapMel: l'échéance arrive bientôt. Sans veto de ta part avant le 19/07 midi, ou de @frederic-santos , peut-on intégrer cette proposition dans le texte? (en gras, les éléments changés - on peut retirer la mention aux hamsters, bien entendu)

Alternative: Quoique essentiel à la compréhension des résultats, le logiciel n'est pourtant pas toujours identifié comme une ressource à préserver ; faute de réel archivage, maint renvoi pointe vers des sources déplacées ou perdues. Un article de D. Spinellis[3] fournit ainsi des éclairages sur la courte durée de vie des URL dans les articles publiés (plus qu'un hamster mais moins qu'un labrador).

Version actuelle: Quoique essentiel à la compréhension des résultats, le logiciel n'est pourtant pas toujours identifié comme une ressource à préserver ; faute de réel archivage, maint renvoi pointe vers des sources déplacées ou perdues. Selon D. Spinellis, la demi-durée de vie d'une URL citée dans un texte publié n'est que d'environ quatre ans3.

[sabrinagranger]

Hello @frederic-santos et @BapMel: n'ayant pas reçu de veto suite aux propositions de modifications, c'est intégré au texte: la conclusion remplace le résumé ; le hamster et le pingouin (Frédéric a fait un travail intense de lobbying contre le syndicat des labradors) remplacent la mention à la demie durée de vie des URL.

[DMathelier]

Bonjour Sabrina @sabrinagranger, Baptiste @BapMel, and Frédéric @frederic-santos

Un grand merci pour les corrections apportées sur votre leçon, nous allons pouvoir maintenant passer à la phase 4 (évaluation).

Lien de consultation de la leçon : http://programminghistorian.github.io/ph-submissions/fr/en-cours/originales/preserver-logiciels-recherche

J’assume le rôle de rédactrice responsable du suivi du processus d’évaluation. Dans ce cadre, je vais solliciter une relecture formelle auprès de la communauté, annoncer ici les noms des personnes responsables de l’évaluation et coordonner les échanges qui auront lieu sur ce fil de commentaires.

Tout membre de la communauté peut également faire un retour constructif sur ce fil de commentaires, après avoir pris connaissance de nos consignes aux évaluateurs et aux évaluatrices et accepté notre politique contre le harcèlement (voir ci-dessous).

Les relecteurs et les relectrices peuvent utiliser la numérotation des paragraphes fournie dans l’aperçu de la leçon pour organiser leurs commentaires, si cela leur convient, tout en demeurant libres de présenter leur évaluation de la manière qui leur semble la meilleure.

Nous demandons que toutes les relectures cessent après réception de l’évaluation formelle, pour que les autrices et auteurs puissent travailler sur la révision de leur leçon. J’annoncerai sur ce fil quand cette étape aura été atteinte.

La discussion ouverte s’organise sur GitHub à même ce fil de commentaires. Si quelqu’un préfère de discuter de manière privée, vous pouvez m’envoyer un mail à l’adresse suivante : [email protected]. Vous avez toujours la possibilité de vous tourner vers notre médiatrice si vous avez le sentiment qu’une médiation est nécessaire. Il n’y a aucun risque que ceci ait une incidence négative sur l’évaluation de cette leçon.

---

Politique contre le harcèlement

Vous trouverez ci-dessous les principes du Programming Historian en français qui doivent inspirer les échanges entre évaluateurs et évaluatrices, autrices et auteurs, rédacteurs et rédactrices, ainsi que toute personne contribuant à nos forums publics.

Le Programming Historian en français tient à garantir un environnement académique ouvert à la communauté, qui offre la pleine liberté d’explorer minutieusement des idées, poser des questions, faire des suggestions ou demander des clarifications. Il fournit aussi un espace libre de toute discrimination envers les personnes contribuant au projet indépendamment du genre, de l’orientation sexuelle, des situations de handicap, de l’apparence physique, de la masse corporelle, de l’origine, de l’âge, de la religion ou de l’expérience technique.

Nous ne tolérons aucune forme de harcèlement ou d’attaque personnelle contre les membres de la communauté. Les personnes qui violent ces règles sont susceptibles d’être expulsées de la communauté à la discrétion du conseil éditorial.

Toute personne en mesure de témoigner de tels comportements ou qui en est la victime peut contacter notre médiatrice (Hélène Huet). Merci de nous aider à créer un espace d’échange et de discussion sûr.

[DMathelier]

Merci à Chiara @chiaraMainardi et à Martin @martinAmouzou d'avoir accepté de relire cette leçon !

Le délai d’évaluation est d’un mois habituellement mais puisque nous sommes en période estivale nous pouvons vous donner un peu plus de temps si besoin. Vos retours seront donc attendus début septembre :)

Pour transmettre vos commentaires, il vous suffit de répondre directement à ce ticket. Vous pouvez vous aider de la numérotation des paragraphes proposées dans le lien de visualisation.

Rappel : les consignes aux évaluateurs/trices sont disponibles ici.

Bonne lecture et merci encore !

[anisa-hawes]

Bonjour Sabrina @sabrinagranger, Baptiste @BapMel, and Frédéric @frederic-santos,

What's happening now?

Your lesson has been moved to the next phase of our workflow which is Phase 4: Open Peer Review.

This phase is an opportunity for you to hear feedback from peers in the community.

Daphné @DMathelier has invited three reviewers (Chiara @chiaraMainardi, Martin @martinAmouzou and Magaye Sall)) to read your lesson, test your code, and provide constructive feedback. In the spirit of openness, reviews will be posted as comments in this issue (unless you specifically request a closed review).

After both reviews, Daphné will summarise the suggestions to clarify your priorities in Phase 5: Revision 2.

%%{init: { 'logLevel': 'debug', 'theme': 'dark', 'themeVariables': {
              'cScale0': '#444444', 'cScaleLabel0': '#ffffff',
              'cScale1': '#3d7c81', 'cScaleLabel1': '#ffffff',
              'cScale2': '#444444', 'cScaleLabel2': '#ffffff'
       } } }%%
timeline
Section Phase 3 <br> Revision 1
Who worked on this? : Authors (@sabrinagranger, @BapMel, @frederic-santos)
All  Phase 3 tasks completed? : Yes
Section Phase 4 <br> Open Peer Review
Who's working on this? : Reviewers (@chiaraMainardi, @martinAmouzou // + @magayesall)
Expected completion date? : ~15 September // 16 Oct (@magayesall)
Section Phase 5 <br> Revision 2
Who's responsible? : Authors (@sabrinagranger, @BapMel, @frederic-santos)
Expected timeframe? : ~30 days after editor's summary

Note: The Mermaid diagram above may not render on GitHub mobile. Please check in via desktop when you have a moment.

[martinAmouzou]

Merci à @sabrinagranger, @BapMel et @frederic-santos pour cette riche leçon sur la la préservation et l'identification des logiciels de recherche avec Software Heritage. Après relecture, voici un petit commentaire (il y en a pas beaucoup) fait sur le fond dans le but d'apporter un peu plus d'informations aux lecteurs. J'utilise la numérotation des paragraphes telle qu'elle apparaît dans la prévisualisation pour indiquer le paragraphe sur lequel porte le commentaire.

§ 12 : Ne serait-il pas utile de préciser qu'il y a des langages de programmation sur lesquels il n'est obligatoire de compiler le code source avant de le rendre exécutable sur une machine en faisant la distinction entre les langages interprétés (à l'instar de Python, R etc.) et les langages compilés (C, C++, Java etc.) ?

[anisa-hawes]

Merci beaucoup, Martin @martinAmouzou.

I might be wrong, but it appears that your review may have been inadvertently truncated here? Did you intend to share a list of comments/suggestions?

[martinAmouzou]

Hello Anisa @anisa-hawes !

I'm not sure but may be It has been truncated. I was sharing a suggestion on the 12th paragraph of this course.

[anisa-hawes]

Okay - thank you for confirming, @martinAmouzou.

[chiaraMainardi]

Tout d'abord, merci à @DMathelier https://github.com/DMathelier de m'avoir proposé l'évaluation de cette leçon ! J'ai trouvé ce tutoriel clair et bien structuré : il permet de comprendre facilement les enjeux complexes de l'archivage des logiciels. A la lecture de cette leçon, le sujet devient accessible aussi aux non-spécialistes tout en fournissant des conseils pratiques et précieux à tous les niveaux. Les objectifs sont clairement définis pour chaque section et bien visibles dans les titres de chaque partie. Le tutoriel présente une partie explicative suivie d'une partie plus pratique, qui détaille comment les lecteurs peuvent appliquer les concepts de la leçon pour leurs propres travaux. Notamment, à partir du § 47, la leçon est technique mais toujours accessible tant aux débutants qu'aux experts. Si le lecteur a besoin d'apprendre comment archiver et décrire un logiciel, il peut utiliser les solutions proposées : les différentes étapes sont bien expliquées, même si elles sont assez laborieuses pour un novice. Les captures avec les vidéos explicatives permettent de rendre les manipulations très praticables.

Ci-dessous, veuillez trouver mes remarques sur la leçon :

§ 2

• Sauf erreur de ma part, le lien n'est pas fonctionnel "Si l’archivage et l’ouverture des données de recherche http://programminghistorian.github.io/fr/preserver-ses-donnees-de-recherche ".
• Il me semble que, si on veut s'adresser aussi à un public de non-spécialistes des logiciels, le paragraphe § 2 explique un peu trop vite le lien entre ouverture des données, leur archivage, la reproductibilité des travaux scientifiques et le lien avec les logiciels. Il serait approprié de reformuler ce paragraphe introductif sur le même ton du § 1, qui est très clair et captivant.

§ 5 Pour un lecteur lambda, la parenthèse "(plus qu’un hamster mais moins qu’un pingouin)" est un peu obscure : on ne voit pas très bien le lien avec la phrase précédente ou la note de fin.

§ 60 Le lien au point 3. (rsync://ftp.gnu.org/gnu/gcc/gcc-4.9.3) ne fonctionne pas.

§ 77 Pour rendre la leçon plus adaptée aux débutants, il faudrait peut-être prendre en considération l'idée d'insérer des liens pour Mercurial et SVN.

§ 82 Pour ce paragraphe, concernant l'ajout de la licence, il serait utile de renvoyer au moins à une page d'explication des différentes licences existantes.

§ 102 Sauf erreur de ma part, le lien CodeMeta ne fonctionne pas ("En effet, consultez par exemple ce fichier CodeMeta, fournissant les métadonnées pour le serious game Plagiator").

§ 112 Idem pour la note de fin n. 2 (Spinellis, Diomidis : https://doi:10.1145/602421.602422), le lien ne fonctionne pas.

[frederic-santos]

Bonjour à tous,

Merci beaucoup à @chiaraMainardi et @martinAmouzou pour vos commentaires positifs et vos suggestions ! J'ai tenté de toutes les implémenter dans les derniers commits. (@sabrinagranger voudra peut-être re-modifier le §3 pour l'améliorer encore un peu.)

Concernant le premier lien au tout début du texte ("Si l’archivage et l’ouverture des données de recherche..."), le lien a été écrit comme un lien relatif PH plutôt qu'un lien absolu ; je pense qu'il fonctionnera lors de la mise en ligne finale (mais c'est à confirmer).

Merci encore pour vos retours !

[DMathelier]

Merci à @martinAmouzou et à @chiaraMainardi pour vos relectures et vos commentaires relatifs à cette excellente leçon. Une troisième lecture est en cours par @magayesall, elle ne devrait pas tarder.

@sabrinagranger, @BapMel, @frederic-santos : il est préférable d’attendre que tous les avis soient publiés ici dans ce ticket avant d'intégrer les suggestions qui vous sembleront pertinentes. Quand tous les avis seront arrivés, j’écrirai une petite message ici pour synthétiser les trois évaluations et vous donner le go !

[DMathelier]

@frederic-santos Je crois que nos messages se sont croisés ;) Ce n'est pas grave si vous avez déjà fait les modifications proposées mais une troisième relecture est en cours, donc vous aurez peut-être besoin de faire de nouvelles corrections dans votre leçon.

[frederic-santos]

Oops. 😅 (Je pensais qu'il n'y aurait que deux reviewers, désolé !) Pas de problème en tout cas, je repasserai sur le texte quoi qu'il arrive. Merci !

[DMathelier]

Merci @frederic-santos, j'allais vous prévenir mais vous avez été d'une remarquable réactivité ;)