FR:Bons commentaires de groupe de modifications
- NDT : le mot anglais changeset est souvent non traduit lors de discussions car il s’agit d'un mot souvent utilisé dans le « jargon » du contributeur OpenStreetMap. Certains éditeurs le traduisent cependant comme « groupe de modifications ».
Qu'est ce qu'un commentaire de changeset
Un changeset est un groupe de modifications réalisées sur OSM par un contributeur.
Quand vous envoyez un changeset, l'éditeur que vous utilisez vous donne l'opportunité d'ajouter une description de votre groupe de modifications - les vues suivantes sont respectivement celles de iD, de Potlach et de JOSM :
- Boîte de dialogue de plusieurs éditeurs
Le commentaire que vous saisissez ici sera celui publié avec vos éditions dans de nombreuses situations, comme par exemple si quelqu'un regarde l'historique d'un objet ou surveille tous les changements affectant une zone.
Pourquoi devrais-je utiliser les commentaires de Changeset ?
Il y a plusieurs raisons qui devraient vous faire utiliser les commentaires sur vos changesets pour décrire vos éditions :
- Par courtoisie envers vos collègues cartographes, car il rend plus facile la compréhension de ce que vous avez fait et pourquoi. Ne pas utiliser le commentaire de changeset a l'air de vouloir dire "Ce n'est pas votre affaire ce que j'ai fait ici et pourquoi" et ne correspond pas à l'esprit d'un projet dans lequel nous travaillons tous à faire la même chose !
- Pour éviter les malentendus et réparer les erreurs rapidement - Si une édition avec comme commentaire de changeset : "Tracé d'un couple de maison à l'aide de Bing" a supprimé 50 restaurants, alors il est clair qu'il y a sûrement eu une erreur, alors que le commentaire de changeset "suppression de restaurants que j'ai vu fermés lors de repérages sur le terrain la semaine dernière" rendra clair le fait que vous avez réellement supprimé ces restaurants pour de bonnes raisons.
- Pour améliorer la valeur de vos éditions et prévenir les guerres d'éditions en expliquant pourquoi vous avez fait telles éditions et en notant vos sources pour ces éditions. Si quelqu'un pense que vous avez ajouté une maison qui n'est pas visible sur ses images aériennes, il sera tenté de la supprimer, mais si vous avez commenté votre changeset de la sorte "ajouté une maison nouvellement construite", alors il y pensera à deux fois avant de la supprimer !
Certains contributeurs utilisent aussi le commentaire de changeset pour enregistrer quelque chose qu'il n'ont pas, ou pas encore fait ("... mais cela mérite encore plus de travail", "... mais la partie ouest de la rivière manque encore").
Il y a des situations où il est évident de voir le but d'un changeset - spécialement lorsque ce changeset n'affecte qu'un seul objet - mais ces situations sont bien moins communes que vous pensez. Si vous corrigez une typographie, un commentaire "correction typo" indiquera toujours plus clairement que c'est en effet ce que vous avez eu l'intention de faire, plutôt que votre chat qui a encore joué avec votre clavier !
Exemples
Un bon commentaire de changeset devrait décrire de manière adéquate et concise une édition.
Bons commentaires
Voici de réels bons exemples de changeset :
- "Mise à jour d'adresses sur la Danish street addresses depuis OSAK (AWS): Bag Hegnet"
- "Attention, les bâtiments supprimés ont été rasés fin 2010, ne les ajoutez pas a nouveau svp"
- "Ajouté une jonction pour les piétons de Donnington à la voie romaine selon des connaissances locales"
- "Mise à jour des frontières du park Algonquin"
- "Ajouté des routes de campagnes et pistes cyclables au SE de Newport"
- "Cologne: supprimé junction=roundabout sur carrefours qui n'en sont pas, pas de panneau de signalisation n°215"
- "Ajouté quelques bras de mer à la ligne de cote de Maranhão"
- "Ajouté des bâtiments dans une zone industrielle"
- "Itinéraire cycliste Stora Vargleden. Routes et chemins dans Tiveden."
- "Ajouté des détails dans Upper Ferntree Gully - Montrose Victoria, Australia depuis Bing et surveillance à la suite du bot de rédaction"
- "Mis à jour les routes autour du Wolf Lake Bemiji MN basé sur des photos satellite"
- "Ajouté la zone naturelle Hawthorn Pond (Holland Twp. MI), ces chemins et aménités"
- "Corrigé le quai du port de LSO"
- "Ajouté des maisons et des numéros de maisons selon Bing et connaissance locale. Quelques numéros de maison n'ont malheureusement pu être trouvé"
Mauvais commentaires
Certains commentaires de changeset sont inutiles et n'apportent aucun de bénéfices qu'un commentaire peut apporter, voici ainsi quelques exemples de mauvais commentaires de changeset :
- "BBOX:3.23,41.96,3.23,41.96 ADD:14 UPD:0 DEL:0"
- "Envoi d'éditions par ArcGIS Editor for OpenStreetMap feature service dec20 at 1/13/2012 9:56:00 AM"
- "Quelques corrections"
- "Ajouts à la carte"
- "#project-1365"
- "--"
Commentaires inutiles et/ou toxiques
Mais il y a des commentaires qui sont encore pire qu'inutiles - quelques exemples de très mauvais commentaires de changeset:
- "Que l'idiot qui a codé ce truc apprenne à donner des messages d'erreur utiles, svp"
- "F*** Potlach2, fatigué de réparer les séquelles de ce bug"
- "F*** Merkaartor SVN."
- "dfshksdhkhksdfhkasf (stupide exigence de JOSM)"
- "Ou j'étais, et pourquoi et quand, ce n'est l'affaire de personne"
Rappelez-vous s'il vous plaît que vos commentaires de changeset vont rester dans la base de donnée aussi longtemps que le projet existera; ne les utilisez pas pour exprimer de la colère contre les logiciels ou vos collègues contributeurs qui vous ont peut être demandé de corriger quelque chose, ou mis en question vos sources.
Prudence lors d'ajout à un changeset existant
Essayez de garder vos changesets d'une taille raisonnable, à la fois en nombre de changements et en étendue géographique.
Quand vous envoyez un changeset et spécifiez un commentaire, l'éditeur ne ferme pas toujours le changeset, les éditions ultérieures peuvent être ajoutées au même changeset et ainsi partager le même commentaire de changeset.
Comportements de différents éditeurs:
- iD crée un nouveau changeset pour chaque upload. → Cette section n'est donc pas pertinente pour iD.
- Potlatch (version 1 et 2) ajoute toutes vos éditions à un changeset existant par défaut, mais vous pouvez fermer le changeset en cours en appuyant sur la touche "C".
- JOSM crée un nouveau changeset pour chaque envoi par défaut, mais vous pouvez changer ce réglage dans l'onglet Paramètres de la boite de dialogue d'envoi.
Si vous avez fini un travail d'édition et commencez à éditer autre chose, faites attention à bien enregistrer cette nouvelle édition dans un changeset séparé, avec son commentaire approprié.
Réutilisation d'anciens commentaires
La plupart des éditeurs permettent de réutiliser un ancien commentaire dans une liste déroulante ou après en avoir tapé les premières lettres dans le champ de texte. Cela a parfois du sens, mais ne tombez pas dans le piège de la facilité en utilisant des commentaires trop génériques ("quelques corrections") juste pour pouvoir les réutiliser pour toutes vos éditions. Cela rend les commentaires inutiles. Prenez soin aussi de ne pas utiliser un ancien commentaire qui ne correspond pas à vos éditions.
JOSM pré-remplit le champ de commentaire avec le dernier commentaire de changeset par défaut (si celui-ci est suffisamment récent). Ceci peut mener à la réutilisation accidentelle d'un ancien commentaire (erroné).
Hashtags
Certains utilisateurs ont commencé à utiliser des "hashtags" dans les commentaires de changesets. Comme les hashtags sont généralement destinés aux machines et non aux humains, la question de savoir si les hashtags ont leur place dans les "bons commentaires de changesets" a été débattue et n'a pas abouti à un consensus. OpenStreetMap permet d'ajouter d'autres tags aux changesets, et les mots-clés lisibles par les machines auraient davantage leur place sous un tag distinct comme "keywords" ou "hashtags". Depuis août 2017, l'éditeur iD prend en charge un champ "hashtags" séparé lors des envois de changesets. Malgré cela, certains outils pré-remplissent les commentaires de changesets avec des hashtags que d'autres outils vont utiliser, ou dont ils vont même dépendre, pour analyser/visualiser des changesets. Les hashtags sont simplement des mots dans le champ de texte libre avec le préfixe dièse (#). Ils peuvent être utilisés ou entrecoupés avec du texte composé manuellement pour obtenir un commentaire lisible par les humains. Un bon commentaire de changeset devrait certainement faire cela plutôt que d'inclure uniquement du texte pré-rempli.
Voir aussi
- comment - comment les commentaires de changeset sont stockés dans la base de donnée
- Template:UserAppreciatesGoodChangesetComments - pour utiliser ce template, mettre {{UserAppreciatesGoodChangesetComments}} sur votre page utilisateur.