diff --git a/README.md b/README.md index 1828ddc..0569a44 100644 --- a/README.md +++ b/README.md @@ -1,3 +1,5 @@ +**v1.0.0** + *#mainteiner:* @zgorcsos ![][#headerpic] @@ -19,6 +21,12 @@ * Mivel a fő megjelenítőnk a gitlab, ezért *GitLab Flavored Markdown*-t használunk. A cél, hogy a gitlab [kiszólgálónkon][#ourgitlab] jól nézzen ki. GFM-ről dokumentáció [itt][#gitlabmddoc] * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] * Vagy egyszerűen használd a gitlab beépített markdown editorát... +* Minden egyes MD fájl külön verziózást kap, amit a fájl első sorában kell feltüntetni (pl.: v1.2.3). + * A verziózás [Semantic Versioning][#semver] szerint történik az alábbi egyértelműsítések figyelembe vételével: + * API: A dokumentáció szemantikai (jelentés)tartalma + * Patch: Csak szerkesztési (editorial) kategóriájú változtatások (lásd: contribution.md) + * Minor (compatibility API change): Kizárólag olyan szemantikai változtatások, melyek nem tartalmaznak ellentétes állításokat az előző verzió állításaival, és nem hagynak el elemeket belőle (tehát bővítik a szemantikát és nem megváltoztatják a létezőt, vagy szűkítik azt) + * Major (incompatibility API change): Olyan szemantikai változtatások, melyek megváltoztatják az előző verzió állításait, vagy elhagynak abból elemeket. > # **Follow the rules!** @@ -27,3 +35,4 @@ [#ourgitlab]: [#gitlabmddoc]: [#markdownmonster]: +[#semver]: \ No newline at end of file -- libgit2 0.21.2