Projektin muutosten kirjaaminen

Kokeneet kirjoittajat eivät ole vielä tarkistaneet sivun nykyistä versiota, ja se voi poiketa merkittävästi 25. kesäkuuta 2018 tarkistetusta versiosta . tarkastukset vaativat 2 muokkausta .

Projektin muutosloki ( englanniksi  changelog ) on ​​ohjelmiston kirjaus suureen projektiin tehdyistä muutoksista. Tämä projekti voi olla verkkosivusto tai ohjelmistoprojekti. Yleensä muutoslokimerkinnät sisältävät tietoa virheenkorjauksista, uusista ominaisuuksista ja niin edelleen. Useimmat avoimen lähdekoodin projektit sisältävät muutoslokin yhtenä ylimmän tason tiedostoista.

Muutostiedostojen kanoninen nimi on ChangeLog , [1] , mutta siihen viitataan joskus nimillä MUUTOKSET tai HISTORIA ( UUTISET kutsutaan yleensä versionmuutostiedostoiksi, ei muutoslokiksi). Jotkut projektin ylläpitäjät lisäävät .txt -liitteen tiedoston nimeen .

Jotkut versionhallintajärjestelmät pystyvät tuottamaan tarvittavia tietoja, jotka soveltuvat muutosten kirjaamiseen.

Muoto

Muutostiedostot on järjestetty kohteiden mukaan, jotka määrittelevät funktioon tai tiedostoon ainutlaatuiset muutokset. Useimmilla muutostiedostoilla on seuraava muoto: [2]

VVVV-KK-PP John Doe <[email protected]> * myfile.ext(myfunction): tekemäni muutokset lisämuutoksia * myfile.ext (unrelated_change): tekemäni muutokset osoitteeseen myfile.ext, mutta ei liity täysin yllä olevaan * otherfile.ext (joku toiminto): lisää muutoksia

Huomaa, että päivämäärän ja nimen välissä ja sitten nimen ja sähköpostiosoitteen välissä on välilyöntejä. Sääntönä on myös, että sähköpostiosoite merkitään lainausmerkkeihin < ja >. Emacs - editori lisää nämä ylimääräiset muutoslokimerkinnät .

Wikipedian muutosten kirjaaminen

Useimmat Wiki - projektiohjelmistot sisältävät muutoslokin perustavanlaatuisena ominaisuutena (jota kutsutaan usein historiaksi tässä yhteydessä ). Esimerkiksi Wikipedia -ikkunan yläosassa oleva "Historia"-linkki vie sinut artikkelin muutoslokisivulle. Tämä ominaisuus on elintärkeä joidenkin tekijänoikeuslisenssien nimeämisvaatimusten täyttämiseksi.

Katso myös

Muistiinpanot

  1. GNU automake -opas . Käyttöpäivä: 27. joulukuuta 2011. Arkistoitu alkuperäisestä 27. joulukuuta 2011.
  2. GNU-koodausstandardit: Muutoslokien tyyli . Käyttöpäivä: 27. joulukuuta 2011. Arkistoitu alkuperäisestä 26. joulukuuta 2011.

Linkit