Blame view

README.md 1.26 KB
84318e82   Görcsös Zoltán   Readme szerkesztése
1
  ![][#headerpic]
157cb697   Görcsös Zoltán   readme.md tartalo...
2
3
  
  # devprocdoc = Developer Process Documentation
84318e82   Görcsös Zoltán   Readme szerkesztése
4
  > A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját.
157cb697   Görcsös Zoltán   readme.md tartalo...
5
  
84318e82   Görcsös Zoltán   Readme szerkesztése
6
  ## Szabályok:
157cb697   Görcsös Zoltán   readme.md tartalo...
7
8
9
  * A dokumentáció **kizárólag** markdown alapú!
  * A dokumentáció organizációja **könyvtárakra** törve történik
  * A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek.
84318e82   Görcsös Zoltán   Readme szerkesztése
10
11
12
13
14
15
16
  * A diskurzus a dokumentáció tartalmáról **kizárólag** itt történik! 
      * Használd a beépített **Issue tracckert**
      * és a **commitok** megjegyzés hozzáfűzési lehetőségé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 gitlabon 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... 
157cb697   Görcsös Zoltán   readme.md tartalo...
17
  
84318e82   Görcsös Zoltán   Readme szerkesztése
18
19
20
21
22
  > # **Follow the rules!**
  
  [#headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png>
  [#gitlabmddoc]: <https://gitlab.com/help/user/markdown>
  [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>