README.md 1.26 KB

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
  • A repository az MD fájlokon túl képeket tartalmazhat, melyek a markdown fájlokban hivatkozásra kerülnek.
  • 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
  • Jó offline MD szerkesztő: Markdown Monster
  • Vagy egyszerűen használd a gitlab beépített markdown editorát...

Follow the rules!