VRH / devprocdoc

Commit fa681b6e7f9453b7789524565092cd74d1e9a432

Authored by Görcsös Zoltán
1 parent d750c895

Add versioning rules

Showing 1 changed file with 9 additions and 0 deletions   Show diff stats
Inline Side-by-side
  1 +**v1.0.0**
  2 +
1 *#mainteiner:* @zgorcsos 3 *#mainteiner:* @zgorcsos
2 4
3 ![][#headerpic] 5 ![][#headerpic]
@@ -19,6 +21,12 @@ @@ -19,6 +21,12 @@
19 * 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] 21 * 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]
20 * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster] 22 * Jó offline MD szerkesztő: [Markdown Monster][#markdownmonster]
21 * Vagy egyszerűen használd a gitlab beépített markdown editorát... 23 * Vagy egyszerűen használd a gitlab beépített markdown editorát...
  24 +* 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).
  25 + * A verziózás [Semantic Versioning][#semver] szerint történik az alábbi egyértelműsítések figyelembe vételével:
  26 + * API: A dokumentáció szemantikai (jelentés)tartalma
  27 + * Patch: Csak szerkesztési (editorial) kategóriájú változtatások (lásd: contribution.md)
  28 + * 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)
  29 + * 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.
22 30
23 > # **Follow the rules!** 31 > # **Follow the rules!**
24 32
@@ -27,3 +35,4 @@ @@ -27,3 +35,4 @@
27 [#ourgitlab]:<http://gitlab.vonalkod.hu:443/vrh/devprocdoc> 35 [#ourgitlab]:<http://gitlab.vonalkod.hu:443/vrh/devprocdoc>
28 [#gitlabmddoc]: <https://gitlab.com/help/user/markdown> 36 [#gitlabmddoc]: <https://gitlab.com/help/user/markdown>
29 [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx> 37 [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>
  38 +[#semver]: <https://semver.org>
30 \ No newline at end of file 39 \ No newline at end of file