64 views
:::warning Please refer to the Wiki: https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Getting-Started The instructions below are no longer updated. >[name=Fabian] ::: Im folgenden erkläre ich kurz, die Schritte je nach dem Vertrauensstatus, den ihr gegenüber dem Repository besitzt. * Standardmäßig besitzt ihr keinen Vertrauensstatus, was nicht böse gemeint ist, sondern nur bedeutet, dass ihr alle Veränderungen in eurem eigenen Namensraum vorbereiten müsst. In diesem Fall beantragt Zugang zum Repository (`request access`, oder folgt der Anleitung für non-`developer`s in der unteren hälfte. * Falls ihr als `Reporter`, `Developer`, `Maintainer` in dem Repository eingetragen wurdet, könnt ihr direkt Änderungen an dem Repository vornehmen (aus Gründen der Qualitätssicherung aber nicht überall). Folgt daher der Anleitung für `developer`! # Merge-Request für Developers This part is no longer kept up to date. Please refer to https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Getting-Started for an updated version ## Versuche den folgenden Ablauf einzuhalten: `issue` -> `merge-request` -> Bearbeitung -> `mark-as-ready` -> `merge` ## Beispiel: * `Issue`: Du möchtest ein Thema anlegen oder hast einen Fehler entdeckt, ziehe eine Ticket (`Issue`) * `feature-branch`: Löse dein Problem, indem du den Fehler behebst * `merge-request`: Biete deine Lösung an, damit sie in den `dev`elopment Branch integriert werden kann (Inhaltliche Qualitätssicherung) * `merge to master`: Hier werden nur Inhalte/Lösungen veröffentlicht, die stabil sind und nochmals geprüft wurden (Technische Qualitätssicherung) ## Schrit für Schritt Anleitung 1. Issue erstellen (damit bringst du zum Ausdruck, dass du etwas verändern möchtest) ![](https://writemd.rz.tuhh.de/uploads/upload_671c37118f0224c03ff22c4e5c22687e.png) ![](https://writemd.rz.tuhh.de/uploads/upload_ab695e0c7f3a0098f94b1fe1b8702bd6.gif) 2. Beschreibung ausfüllen (was hast du vor? Ganz kurz.) ![](https://writemd.rz.tuhh.de/uploads/upload_fa227834c185963d4ff5323bc89c2ecd.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_9a6e097d3bffe5460a7d53ef368fa8ad.png) * Ordne das Pr * Wähle ein Passendes Label (z.B. `typo` oder `research-topic`). Siehe [hier](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/labels) für eine vollständige Liste aller Labels 3. Erzeugung über **Create issue** abschließen ![](https://writemd.rz.tuhh.de/uploads/upload_9a107db8950a287351f8006f75503dec.png) 4. Merge request erzeugen (Bereite deinen Arbeitsbereich vor (`Branch`)) ![](https://writemd.rz.tuhh.de/uploads/upload_b0a1f64c60e68691b836428a916e44c5.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_4f6e00ee45bab4a67212395ba61936c3.png) ![](https://writemd.rz.tuhh.de/uploads/upload_70ae9b99a52342586310570ba8292c51.png) 5. Gerne den voreingestellten Branch name nutzen, und nach `dev` (auch voreingestellt) mergen ![](https://writemd.rz.tuhh.de/uploads/upload_39936ac34443281913756ae2cb018b55.png) 5.1 Optional ein passendes Label auswählen (falls nicht schon beim Issue getan, für inhaltliche Beiträge/Korrekturen `research-topic` oder `typo`) ![](https://writemd.rz.tuhh.de/uploads/upload_0c738433e05579c3b02e36a662d1b8d8.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_6c523deff7af01a12d22bf704a631bde.png) 6. Jetzt auf dem Branch (im obigen Beispiel) `4-example-issue` lokal oder im Repo arbeiten. Am einfachsten geht dies über `Open in Web IDE`: ![](https://writemd.rz.tuhh.de/uploads/upload_396161a8be5d45c7bcfcff83e23cda9c.png) * Die Markdown Dateien für die Topics finden sich im Ordner `topics` (s.a. [Repository-Structure](https://collaborating.tuhh.de/cfg0846/research-topics-mat-tuhh/-/wikis/Repository-Structure)) ![](https://writemd.rz.tuhh.de/uploads/upload_e2d25f979cd0f9113f3ba0f61d6b63d9.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_a0e8dd88afbdc8a61c7278865b94b5e2.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_910afd1bdc880ed96d05d3696290b883.gif) ![](https://writemd.rz.tuhh.de/uploads/upload_9fd722857b89b1ce6132c2439ae18779.gif) * Alternativ im Repository zu der gewünschten Datei bzw. dem Ablageort navigieren, und sie über `edit` bearbeiten bzw. sie über +new file hinzufügen (hierfür muss jedoch der zuvor erzeugte Branch ausgewählt sein): ![](https://writemd.rz.tuhh.de/uploads/upload_7bbbeb2fa16a7e60b8061f27f4216fe6.png) * du kannst deine Datei auch im Online-Markdown Editor [HedgeDoc](https://writemd.rz.tuhh.de/) bearbeiten und anschließend per copy&paste in das Repo kopieren 7. Nach einem Bearbeitungsschritt mit `Commit` die Bearbeitung speichern. ![](https://writemd.rz.tuhh.de/uploads/upload_87a89d4f3ec87a197895b7444c572082.png) 8. Kehre zum Merge request zurück: ![](https://writemd.rz.tuhh.de/uploads/upload_b65c73cf4c2fc4bad7f31df160c621cd.png) 9. Warte bis die Pipeline durchgelaufen ist ![](https://writemd.rz.tuhh.de/uploads/upload_8edd37d1f504a82e2c8e0a77edae0ea1.png) ![](https://writemd.rz.tuhh.de/uploads/upload_f51cd45c68f0e95122226310a9d4834d.gif) 10. Schau dir in der Review App eine Webseitenvorschau an ![](https://writemd.rz.tuhh.de/uploads/upload_121b54cd1fec57abcd5e0edb33a4059f.png) 9. Gib Bescheid, dass du fertig bist, oder arbeite weiter auf deinem Branch, s.o. ![](https://writemd.rz.tuhh.de/uploads/upload_6352765aa164f72a8d099af4c72cbe54.png) ![](https://writemd.rz.tuhh.de/uploads/upload_a78112457b2298dc4dc4eb664e2f0cfc.gif) 10. Sehr gut ![](https://writemd.rz.tuhh.de/uploads/upload_93793edb9daa48cb6229a4036cffa7bb.png) Ein Maintainer, wird nun den Merge Request überprüfen. --- # Merge-Request für Non-Depelopers * Du bist auf der Webseite gewesen und hast in einem Research Topic einen Fehler gefunden? Merke dir den Namen des Themas ![](https://writemd.rz.tuhh.de/uploads/upload_abb39c556ec0d5c8c66ce5791e61f5f3.png) ![](https://writemd.rz.tuhh.de/uploads/upload_6d26b0ab327422bab268b227d08c2567.png) * Geh auf unser Webseitenprojekt https://collaborating.tuhh.de/research-topics-mat-tuhh und suche im Ordner **topics** nach der entsprechenden `.md` Datei (ersetze dabei einfach `html` durch `md`) ![](https://writemd.rz.tuhh.de/uploads/upload_a4724d9c7e2b53d3fcf85a01abcacff3.png) * Gefunden! ![](https://writemd.rz.tuhh.de/uploads/upload_b8908e0bcefa96b7ebe4c05b6b2ee694.png) * Wähle die Datei aus, in der du etwas korrigieren willst und klick auf **Edit** * In Hintergrund erstellt GitLab danach einen "Fork" mit einem feature-branch. Ggf. bestätigen und den Fork anlegen lassen. ![](https://writemd.rz.tuhh.de/uploads/upload_a743c12f6da7b14593e7e8195d13a7f1.png) * Klicke auf ![](https://writemd.rz.tuhh.de/uploads/upload_cf96e9a0719619cbffc402c948a87c3b.png) ![](https://writemd.rz.tuhh.de/uploads/upload_801e85884ac1709714571dabad4daa16.png) * Führe Korrekturen, Ergänzungen durch: ![](https://writemd.rz.tuhh.de/uploads/upload_32d91fcbf3c2bee84797a24bdc7f0b47.png) * Nutze die Vorschaufunktion (kann keine Formeln) ![](https://writemd.rz.tuhh.de/uploads/upload_1ae93e23cc18c3c81826ca68c7e8b3a5.png) * Für Formeln kannst du wie zuvor HedgeDoc nnutzen.n * Fertig? ![](https://writemd.rz.tuhh.de/uploads/upload_1cfb558659dfda90d3cc0851aed7c41a.png) * Fertig? Dann beschreibe deine Veränderung kurz und klicke auf commit. ![](https://writemd.rz.tuhh.de/uploads/upload_91acb559c9dd987552ddd6b70432582c.png) ![](https://writemd.rz.tuhh.de/uploads/upload_e13be6e610eeeef4e555dfd608770c97.png) ![](https://writemd.rz.tuhh.de/uploads/u ![](https://writemd.rz.tuhh.de/uploads/upload_24be40c880b447193672004b0953e887.png) * Noch eine Description ergänzen und abschicken ![](https://writemd.rz.tuhh.de/uploads/upload_95bb0329e9f7883858608fec8f2f335c.png) * Ich als Maintainer des Repositories bekomme nun eine Benachrichtigung: ![](https://writemd.rz.tuhh.de/uploads/upload_2b5c4d0f2606837165301625df5e004e.png) * Und entscheide mich die Veränderung zu übernehmen, oder mit dem Einreicher darüber zu diskutieren ![](https://writemd.rz.tuhh.de/uploads/upload_5efcb0429294f5f42b5b8042d761acd0.png) ###### tags: `gitlab`, `tutorial`