Et:Good changeset comments

Miks ma peaksin kasutama muutuskogumi kommentaare?

Muutuskogumi kommentaari kirjutamisel muudatuste kirjeldamiseks võib olla palju põhjuseid:

• Viisakus kaaskaardistajate suhtes, sest see muudab asja nende jaoks lihtsamaks, et aru saada, mis sa oled teinud ja miks. Muutuskogumi kommentaari mittekasutamine edastab mõtet "see pole teie asi, mis ma siin teen ja miks" ja see ei sobi hästi projektiga, kus me kõik töötame sama asja kallal.
• Et vältida vääritimõistmist ja kiiresti parandada vigasid - kui muudatus, mille muutuskogumi kommentaar on "joonistasin Bing-kaardi põhjal paar maja" kustutab 50 restorani, on selge, et tegu peab olema eksitusega, samas kui muutuskogumi kommentaar "eemaldan restoranid mis ma leidsin olevat suletud eelmise nädala retke ajal" annab selgelt mõista, et sa kavatsed kustutada need restoranid põhjusega.
• Et suurendada oma muudatuste väärtust ja vältida redigeerimissõdasid, seletades miks sa tegid midagi ja millised olid su allikad. Kui keegi leiab, et sa oled lisanud maja mis ei ole nähtav maakaartidel, võib neil olla kiusatus see ära kustutada, ent kui muutuskogumi kommentaaris on kirjas "lisasin hiljuti püstitatud hoone" siis nad mõtlevad kaks korda enne kustutamist.

Mõned kaardistaja kasutavad muutuskogumi kommentaari ka selleks, et kirja panna asju, mida nad ei ole teinud või ei ole veel jõudnud teha ("... kuid see vajab veel tööd", "... kuid jõe lääneosa on veel puudu").

On olukordi, kus on ilmselge, mida muutuskogumis tehti - eriti kui see puudutab ainult ühte objekti - ent seda juhtub harvemini kui arvata võiks. Kui sa parandasid kirjavea, siis muutuskogumi kommentaar "parandasin kirjavea" teeb selgeks, et see oli tõesti see mida kavatsesid teha ja et su kass ei mänginud jälle klaviatuuriga.

Näiteid

Hea muutuskogumi kommentaar peaks lühidalt ja selgelt kirjeldama tehtud muudatusi. Muutuskogumi kommentaari head näited on:

• "Uuendasin Taani tänavaaadresse OSAK(AWS) põhjal: Bag Hegnet"
• "Tähelepanu: kustutatud hooned on lammutatud 2010 lõpus, palun ärge lisage neid uuesti."
• "Lisasin jalgtee Donnington Close'st Roman Way-ni tuginedes kohaliku ala tundmisele"
• "Uuendasin Alonquin Park-i piire"
• "Lisasin maateid ja jalgrattatee Newportist kagus"
• "Köln: Kustutasin junction=roundabout mitte-ringteedel, kus puudus liiklusmärk 215"
• "lisasin mõned loodeabajad Maranhão rannajoonele"
• "Lisasin tööstusalale hooneid."
• "Stora Vargleden jalgrattatee. Teed ja rajad Tivedenis."
• "Upper Ferntree Gully - Montrose Victoria, Australia - lisasin bingist ja retkest üksikasju peale redigeerimisrobotit."
• "Uuendasin Wolf Lake Bemiji MN lähedal teid satelliitfotode põhjal."
• "Lisasin Hawthorn Pond Natural area (Holland Twp. MI), selle jalgteed ja objektid."
• "LSO lahe sadamakai õige piir."
• "Lisasin majad ja majanumbrid Bingi ja enda teadmiste põhjal. Kahjuks ei leidnud kõiki majanumbreid."

Mõned muutuskogumi kommentaarid on kasutud ja ei anna mingeid teavet, mida muutuskogumi kommentaar peaks andma - taas tegelikke näiteid:

• "BBOX:3.23,41.96,3.23,41.96 ADD:14 UPD:0 DEL:0"
• "Edit uploaded via ArcGIS Editor for OpenStreetMap feature service dec20 at 1/13/2012 9:56:00 AM"
• "mõned parandused"
• "lisandused kaardile"
• "--"

Ent on ka kommentaare, mis on vähem kui kasulikud - taas mõned näited:

• "Palun kas idioodid, kes seda koodi kirjutavad õpiksid andma kasulikke veateateid."
• "K****i Potlatch2, olen väsinud parandamast selle vea tagajärgi"
• "K****i Merkaartor SVN."
• "dfshksdhkhksdfhkasf (tobe JOSMi nõue)"
• "Kus, miks ja millal ma olin, ei ole kellegi asi."

Tea, et sinu muutuskogumi kommentaarid säilivad andmebaasis seni kuni see projekt elab; ära kasuta neid oma viha väljaelamiseks tarkvara peale või kaaskaardistajate, kes on suunanud sind midagi parandama või on küsitlenud sinu allikate päriolu.

Ettevaatust olemasoleva muutuskogumi täiendamisel

Kui laed üles muutuskogumit ja lisad sellele kirjelduse, siis ei sulge redaktor alati kohe muutuskogumit ja järgmised muudatused võivad lisanduda samale muutuskogumile ning seetõttu jagavad sama muutuskogumi kommentaari.

Kui oled lõpetanud ühe redigeerimisülesande ja alustad millegi muuga, siis veendu, et oled selle "millegi muu" salvestanud eraldi muutuskogumi alla koos sellele vastava muutuskogumi kommentaariga. Potlatch lisab vaikimisi sinu muudatused olemasolevale muutuskogumile, kuid sa võid vajutada klahvi "C", et sulgeda käsilolev muutuskogum. JOSM loob vaikimisi uue muutuskogumi iga üleslaadimise peale, kuid sa võid muuta seda sätet üleslaadimise dialoogiaknas.

Vanade kommentaaride taaskasutamine

Enamik redaktoreid võimaldab sul uuesti kasutada vanemaid kommentaare, näidates neid ripploendis. Sellel võib mõnikord mõte olla kuid ära lange liiga üldiste kommentaaride ("mõned muudatused") "mugavuse lõksu", et sa saaksid neid uuesti kasutada oma kõikide muudatuste juures. See muudab kommenteerimise mõttetuks. Samuti ära kasuta varasemat kommentaari, mis ei vasta tehtud muudatustele.

Vaata ka

• Key:comment - kuidas hoitakse muutuskogumi kommentaare andmebaasis
• Template:UserAppreciatesGoodChangesetComments - et seda malli kasutada lisa {{UserAppreciatesGoodChangesetComments}} oma kasutajalehele.