Projekt változás naplózása

Az oldal jelenlegi verzióját még nem ellenőrizték tapasztalt közreműködők, és jelentősen eltérhet a 2018. június 25-én felülvizsgált verziótól ; az ellenőrzések 2 szerkesztést igényelnek .

A projektmódosítások naplózása ( angolul  changelog ) egy szoftveres naplózás a nagy projekteken végrehajtott változtatásokról. Ez a projekt lehet webhely vagy szoftverprojekt. A változásnapló bejegyzései általában hibajavításokról, új szolgáltatásokról stb. tartalmaznak információkat. A legtöbb nyílt forráskódú projekt a változásnaplót tartalmazza a legfelső szintű fájlok egyikeként.

A változtatási fájlok kanonikus neve ChangeLog , [1] , de néha VÁLTOZÁSOK -nak vagy HISTORY -nak is nevezik ( A HÍREK általában verziómódosító fájloknak nevezik, nem változásnaplózásnak). Egyes projektkarbantartók hozzáadják a .txt utótagot a fájlnévhez .

Egyes verziókezelő rendszerek képesek megfelelő információkat generálni, amelyek alkalmasak a változások naplózására.

Formátum

A változásfájlok olyan elemek szerint vannak rendezve, amelyek egyedi változtatásokat határoznak meg egy függvényben vagy fájlban. A legtöbb módosításfájl a következő formátumú: [2]

ÉÉÉÉ-HH-NN John Doe <[email protected]> * myfile.ext(myfunction): az általam végrehajtott módosítások további változtatások * myfile.ext (unrelated_change): a módosításaim végrehajtva a myfile.ext-hez, de a fentiekhez teljesen nem kapcsolódik * otherfile.ext (valamilyen funkció): további változtatások

Vegye figyelembe, hogy szóköz van a dátum és a név, majd a név és az e-mail cím között. Szintén szabály, hogy az e-mail címet idézőjelbe kell tenni < és >. Ezeket az extra változtatási naplóbejegyzéseket az Emacs szerkesztő adja hozzá .

A Wikipédia változásainak naplózása

A legtöbb Wiki projektszoftver alapvető funkcióként tartalmazza a változásnaplót (ezt ebben az összefüggésben gyakran történelemnek nevezik ). Például a Wikipédia ablakának tetején található "Előzmények" hivatkozás a cikk változásnapló oldalára visz. Ez a funkció létfontosságú bizonyos szerzői jogi licencek hozzárendelési követelményeinek teljesítéséhez.

Lásd még

Jegyzetek

  1. A GNU automake kézikönyve . Hozzáférés dátuma: 2011. december 27. Az eredetiből archiválva : 2011. december 27.
  2. GNU kódolási szabványok: Változásnaplók stílusa . Hozzáférés dátuma: 2011. december 27. Az eredetiből archiválva : 2011. december 26.

Linkek