Blame view

README.md 1.51 KB
a896adde   Görcsös Zoltán   Update readme.md
1
2
  *#mainteiner:* @zgorcsos
  
84318e82   Görcsös Zoltán   Readme szerkesztése
3
  ![][#headerpic]
157cb697   Görcsös Zoltán   readme.md tartalo...
4
5
  
  # devprocdoc = Developer Process Documentation
84318e82   Görcsös Zoltán   Readme szerkesztése
6
  > A repository alatt vezetjük a Vrh fejlesztési folyamatainak dokumentációját.
157cb697   Görcsös Zoltán   readme.md tartalo...
7
  
84318e82   Görcsös Zoltán   Readme szerkesztése
8
  ## Szabályok:
157cb697   Görcsös Zoltán   readme.md tartalo...
9
10
11
  * 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.
a896adde   Görcsös Zoltán   Update readme.md
12
  * A diskurzus a dokumentációk tartalmáról **kizárólag** itt történik! 
84318e82   Görcsös Zoltán   Readme szerkesztése
13
      * Használd a beépített **Issue tracckert**
a896adde   Görcsös Zoltán   Update readme.md
14
15
16
      * 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 hívatkozások használatát
84318e82   Görcsös Zoltán   Readme szerkesztése
17
18
19
20
  * 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...
21
  
84318e82   Görcsös Zoltán   Readme szerkesztése
22
23
24
25
  > # **Follow the rules!**
  
  [#headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png>
  [#gitlabmddoc]: <https://gitlab.com/help/user/markdown>
de4882a9   Görcsös Zoltán   Remove contributi...
26
  [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>