**v1.0.0**
  

  *#mainteiner:* @zgorcsos
  

  ![][#headerpic]

  
  # devprocdoc = Developer Process Documentation

  > A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját.

  ## Szabályok:

  * A dokumentáció **kizárólag** markdown alapú!
  * A dokumentáció organizációja **könyvtárakra** törve történik

  * Az MD fájlokban használt képeket a **web.vonalkod.hu** ftp szerveren a fejlesztes/devprocdoc alá kell feltölteni. Az ftp elérési módja [ezen][#webvonalkodhuftp] a Redmine tudástár oldalon található. Az ide feltöltött fájlokat a http://web.vonalkod.hu/fejlesztes/devprocdoc/továbbiútvonal/fájlnév formában hivatkozuk a dokumentációban. Az ftp szerveren a devprocdoc repoisitory-val egyező könyvtár struktúrát kell kialakítani a devprocdoc könyvtár alatt!
  * A fenti feltöltött, és az md fájlokban hivatkozott képeket a repository-hoz is hozzáadjuk!

  * A diskurzus a dokumentációk tartalmáról **kizárólag** itt történik! 

      * Használd a beépített **Issue tracckert**

      * A **commitok** megjegyzés hozzáfűzési lehetőségét
      * Továbbá az alább leírt szerkesztési szabályokat és a Merge request-ek rendszerét, az azokban végezhető kommentelési lehetőségeket

      * A kommunikációban preferáld az említések, és hivatkozások használatát

  * A project open, hogy a dokumentáció a közvetlen gitlab.vonalkod.hu alatti linkkel egyszerűen meg lehessen osztani **bárkivel**.

  * 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!**
  

  [#headerpic]: <http://web.vonalkod.hu/fejlesztes/devprocdoc/rules.png>
  [#webvonalkodhuftp]:<http://redmine.vonalkod.hu/projects/vrhfejlesztes/wiki/Bels%C5%91_h%C3%A1l%C3%B3zat#VRH-infrastrukt%C3%BAra-WebSzolg%C3%A1ltat%C3%A1sok-elr%C3%A9%C3%A9sei>
  [#ourgitlab]:<http://gitlab.vonalkod.hu:443/vrh/devprocdoc>

  [#gitlabmddoc]: <https://gitlab.com/help/user/markdown>

  [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>

  [#semver]: <https://semver.org>