HTW | Playground: Fork Colors

Das Repository dient im Praktikum als Spielwiese, um Fork und Pull-Request kennenzulernen. Es ist eine kleine Webanwendung, welche über GitHub Page angezeigt wird und anhand einer JSON-Datei Farbkreise darstellt.

• GitHub Page: https://tigion.github.io/htwd-playground-fork-colors/
• Aufgabenstellung im Praktikum: Teil 9 - Aufgabe 2.1 - Fork mit Pull-Request

Worum geht es?

Um einen Farbkreis in diesem Repository zu hinterlassen, muss ein Fork mit einem Pull-Request durchgeführt werden.

Dazu muss in einem Pull-Request die JSON-Datei colors.json im Verzeichnis /data entsprechend ihres Sitzplatzes im Praktikum angepasst werden. Hier wird ein Eintrag mit dem GitHub-Account oder Namen bei id: und einer Farbe im rgb-Format bei color: hinterlassen.

Aufbau der colors.json Datei

In der Datei colors.json befinden sich ein Array von Objekten bestehend aus einer ID (id) und einer Farbe (color):

[
  ...
  {
    "id": "Name",
    "color": { "r": 255, "g": 85, "b": 0 }
  },
  ...
]

Note

Am Ende der colors.json Datei befinden sich vorbereitete leere Einträge zur Verwendung im Praktikum. Der zu nutzende Eintrag, entsprechend des Platzes im Praktikum, ist mit einem Kommentar (_comment) gekennzeichnet:

[
  {
    "_comment": "Reihe 1 Platz 1",
    "id": "",
    "color": { "r": 255, "g": 255, "b": 255 }
  },
  {
    "_comment": "Reihe 2 Platz 1",
    "id": "",
    "color": { "r": 255, "g": 255, "b": 255 }
  },
  ...
]

• _comment: ... Kommentar für Platz im Praktikum, um unnötige Mergekonflikte zu umgehen
• id: ... GitHub-Account oder anderer Name
• color:
  • r: ... Wert von rot zwischen 0 und 255
  • g: ... Wert von gelb zwischen 0 und 255
  • b: ... Wert von blau zwischen 0 und 255

Achtet beim Hinzufügen eines neuen { id: ... colors: ... }-Eintrages darauf, dass sich vor dem letzten Eintrag ein Komma und danach keines befindet.

Vorgehen

1. Forke dieses Repository als Kopie in deinen Account.

2. Clone es lokal auf deinen Rechner.

3. (optional) Erstelle dir einen neuen Branch und wechsle in diesen.

4. Passe einen Eintrag entsprechend deines Platzes im Praktikum (siehe Attribute _comment) an.

   {
     "_comment": "Reihe 2 Platz 1",
     "id": "my_name_or_account",
     "color": { "r": 12, "g": 34, "b": 45 }
   }

   Alternativ: Füge der colors.json am Ende einen neuen Eintrag mit deinen Werten hinzu (dies kann zu merge-Konflikten führen).

5. Nimm die Änderung als neuen Commit auf und pushe sie mit dem zugehörigen Branch in dein Repository.

6. Schlage mir jetzt die Änderung als Pull-Request vor.

7. Ich schaue mir - undefinierte Verzögerung - deinen Pull-Request an. Ist er okay, übernehme ich die Änderung und nach kurzer Zeit ist dein Farbkreis zu sehen. Ist er nicht okay hinterlasse ich einen Kommentar.

8. Ist der Pull-Request erfolgreich von mir übernommen, kann dein Fork (bei nicht gebrauch) gelöscht werden.

Alternativ kann das Editieren direkt auf GitHub im Webbrowser geschehen. Dabei wird automatisch ein Fork mit zugehörigem Pull-Request über einen Änderungsvorschlag (Propose Changes) erstellt. Dies ist nur für die Bearbeitung einer einzelnen Datei empfohlen, da für jede angepasste Datei ein Pull-Request erstellt wird.