VRH / devprocdoc

Commit 4fa6125d1c32e7159c73bb7b0f15cc305e976a70

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

contribution.md

Showing 2 changed files with 46 additions and 2 deletions   Show diff stats
Inline Side-by-side
README.md
  Show/Hide comments   View file @4fa6125
... ... @@ -59,10 +59,10 @@
59 59 7. Dokumentáció hivatkozások mindig a master brancre irányulnak
60 60  
61 61 A branch modell vizuálisan szemléltetve:
62   -
  62 +![][#contribution-branching-model]
63 63 > # **Follow the rules!**
64 64  
65 65 [#headerpic]: <http://gitlab.vonalkod.hu:443/uploads/project/avatar/193/rules.png>
66 66 [#gitlabmddoc]: <https://gitlab.com/help/user/markdown>
67 67 [#markdownmonster]: <https://markdownmonster.west-wind.com/download.aspx>
68   -[#branchmodel-illustration]: <http://gitlab.vonalkod.hu:443/>
69 68 \ No newline at end of file
  69 +[#contribution-branching-model]: <http://nuget.vonalkod.hu/public/devprocdoc/contribution-branching-model.PNG>
70 70 \ No newline at end of file
... ...
contribution.md 0 → 100644
  Show/Hide comments   View file @4fa6125
... ... @@ -0,0 +1,44 @@
  1 +### Dokumentum változtatási szabályok:
  2 +1. A *develop* branchet **nem** használjuk szerkesztésre!
  3 +2. Bármilyen változtatáshoz a __develop__ brenchből egy feauture branch-et kell származtatni.
  4 + * Ezen branchek elnevezése kötött! Jelenleg az alábbi három prefix közül kell **kötelezően** az egyiket alkalmazni:
  5 + 1. **editorial_**: Ilyen cimkével elátott branch-en, kizárólag olyan módosítás végezhető egy létező dokumentumon, amely szerkesztési jellegű változtatást jelent. Nagyon fontos, hogy ilyen branchen nem végezhető el **semmilyen** olyan jellegű módósítás, amelyik a dokumentáció szemantikai tartalmán érdemben változtat!
  6 + * editorial_ branchen végezhető módosítások:
  7 + - Helyesírási hibák, elírások javítása
  8 + - Rossz nyelvi konstrukciók egyélrtelműsítése, javítása
  9 + - Szerencsétlen, nem sikerült megfogalamazások kiigazítása
  10 + * editorial_ branch lezárása:
  11 + - A szerkesztés lezárása, és a szerkesztési módosítás javaslattétele egy a develop branchre létrehozott MR (merge request segítségével történik).
  12 + - Ezen MR célszemélye ("Assign to") a dokumentációban feltüntetett dokumentum legelején "#mainteiner:" címkével feltüntetett felelős, ha nincs ilyen feltüntetve, akkor a fejlesztési vezető
  13 + - editorial_ brancról való olvasztást kizárólag az MR célszemélye, vagy a fejlesztési vezető végezheti el!
  14 + 2. **rfc_**: Minden érdemi tratlami módosításnak, új dokumentáció létrehozáésának egy rfc_ prefixxel elátott branchen kell történnie, függetlenül attól, hogy az adott módosítást ki kivánja végrehajtani a dokumentáción! Ez alól a dokumentum felelőse, és a fejlesztési vezető sem kivétel! (*Az RFC a Request For Comments rövidítése és általánosan elterjedt elnevezés együtmüködés alapú dokumentációk előállításakor.*)
  15 + * Szabályok az rfc_ branchen:
  16 + - Egy rfc_-ben elvégzett módosítás mindig egy a develop brancre létreozott MR (mereg request) formájában kerül publikálásra
  17 + - Egy rfc_-nek egyértelműen egy tulajdonosa van (editor) nem indítunk konkurens commitot egy rfc-re.
  18 + - Ehelyett a szerkesztési együtműködés az rfc-ből származtatott contribution_ prefixxel elátott branchen történik, és az eredeti rfc_ branchre létrehozott MR (merge request) formájában valósul meg. Részletesen lásd a contribution_ prefix leírásánál!
  19 + - Az rfc_ branchekből létrehozott MR-ek célzása:
  20 +
  21 + - Csakis a develop branch-re irányulhat
  22 + - Az MR célszemélye ("assign to") minden esetben a fejlesztési vezető, a Merge kizárólag általa végezhető el!
  23 + - Megengedett ugyanakkor hogy egy dokumentumra párhuzamosan több rfc_ fusson. (Értelemszerűen ezek nem vonatkoznak ugyanazon részekre, mielőtt rfc-t nyitsz, mindig nézde meg, nincs-e már folyamatban egy rá! Ezért fontosak az érthető, beszédes branch elnevezések!)
  24 + 3. **contribution_**: Ha egy futó rfc_-re a commenteken (legyen az egy nyitott issue, commit comment, vagy MR comment) túlmutató javaslat szükséges, akkor az alábbiak szerint kell eljárni:
  25 + * rfc_ brancből egy contribution_ prefixxel elátott branchet kell származtatni
  26 + * A módosításokat itt megejteni, majd majd egy az eredeti rfc_ brancre irányuló MR (merge request) formájában publikálni. Szabályok:
  27 + * A szerkesztési szándékot egyeztetni kell!
  28 + * Az MR célszemélye az rfc eredeti tulajdonosa. A merge-et ő vagy a fejhlesztési vezető végezheti el!
  29 + * **Branchek elnevezése:**
  30 + * A prefixek jobb láthatósága érdekében ne használjuk a branchek elnevezésében a "_" jelet az elnevezés tagolására.
  31 + * Javasolt helyette a kötöjelek alklamazása. Camel Case írásmód is megengedett.
  32 + * Tagolás nélküli elnevezések használata kerülendő!
  33 + * Ne használjunk rövidítéseket, hacsak azok nem vitán felül közismert és egyértelmű jelölések a szakmai nyelvben!
  34 +3. A **develeop** branchen lévő dokumentációk is csak "strawman"-nak tekintendőek!
  35 +4. Ha egy dokumentáció végleges változatként elkészül, akkor a fejlesztési vezető MR-t készít és végez a master branchre.
  36 +5. Hogy a félkész dokumentációk ne blokkolják más dokumentációk publikálását, ezért minden rfc_-t addig tartunk meg, amíg a strawman állapota publikálásra kész változatot nem ér el. A merge a develop brancre csak ezután történik, amelyet általában azonali develop to master merge követ.
  37 +6. A fueture brancheket az elvégzett merge-eket követően töröljük.
  38 +7. Dokumentáció hivatkozások mindig a master brancre irányulnak
  39 +
  40 +A branch modell vizuálisan szemléltetve:
  41 +
  42 +![][#contribution-branching-model]
  43 +
  44 +[#contribution-branching-model]:<http://nuget.vonalkod.hu/public/devprocdoc/contribution-branching-model.PNG>
0 45 \ No newline at end of file
... ...