htw-imi-showtime / showtime-website

The official IMI showtime website
10 stars 104 forks source link

M1 - second release train PR #382

Closed kennethenglisch closed 3 months ago

kennethenglisch commented 3 months ago

M1 - changed images for better quality and smaller file size + textual changes in process.md

Opening a Pull Request to Update your Project

I've started a documentation on how we should use the forking workflow here:

https://github.com/htw-imi-showtime/showtime-website/blob/documentation/doc/forking-workflow/index.md (will not be merged to main due to file sizes)

Please follow these Steps & Guidelines for your Pull Request:

Before you Request a Review Check and Tick these Boxes:

[x] make sure that the hugo site build works and check the result visually. [x] merge your local branch with upstream/main (see update doc) [x] Deploy the Site on your github pages by activating the "Deploy Page using GH-Actions" Workflow in "gh-pages-action.yml" [x] make sure that your PR contains only files / file changes within your project subdirectory. [x] make sure that all your file names consist only of lower case letters, numbers, or [-_.] - with only one . for the file extension [x] delete all unnecessary files from your PR (including cat.jpg and kitty.jpg) [x] check the image file sizes. All Images have to be as small as possible. See ./doc/disk_usage.md about this issues, there's a script: ./bin/images-smaller.sh

Note that if you fail to do so, I may simply reduce the file sizes brute force using the script above - WITHOUT CHECKING THE QUALITY

[x] if everythings seems fine, request a review by bkleinen on github. (on the upper right)

Fill out this Information:

  1. Change the PR Title to: (e.g. B0 - update techstack.md) and describe your changes:

  2. URL of your Preview Site Containing the Changes: https://kennethenglisch.github.io/showtime-website/ss24/master/m1_gaming_for_future/

  3. When did your Project Supervisor review your changes? (Date/Note or require review for PR): we spoke about the changes in our last scrum on monday. I will show it to him again tomorrow.

  4. If your disk usage exceeds 500K, provide a reason while you want to include so many images or why certain images need to be that big:

IMPORTANT: if you run into trouble / If the checks fail...

All good?

If all checks run successfully the PR will be reviewed and, if no further changes are requested, merged and closed. (this is the time to update and start a new branch!)

More Information

We are using the Forking Workflow.

bkleinen commented 3 months ago

du: cannot access 'content/ss24/*/m1-': No such file or directory

kennethenglisch commented 3 months ago

Sehr gern! Ich habe Sie als Collaborator hinzugefügt. Es scheint daran zu liegen, dass ich das Projekt ursprünglich als m1_gaming_for_future und nicht m1-gaming... benannt habe.

bkleinen commented 3 months ago

Habe einen check für den project folder name eingebaut: https://github.com/htw-imi-showtime/showtime-website/actions/runs/9935219175/job/27440980196

bkleinen commented 3 months ago

Damit ist alles fein und ich würde den PR so mergen.

Beim Durchsehen ist mir nur ein Satz aufgefallen:

"We primarily programmed in Unity. Our workflow involved pushing our code to GitLab, where we collaborated on different branches, including 'development' and 'main'."

We primarily programmed in Unity -> vague booking - was versteckt sich hinter "primarily"? - aber da Sie Unitiy im Tech Stack beschreiben, kann das auch hier weg.

Our workflow involved pushing our code to GitLab, -> das ist vom Informationsgehalt knapp über "wir haben sourcecode in einem Editor editiert". Würde ich eher weglassen.

where we collaborated on different branches, including 'development' and 'main -> ... Oder den Workflow oder zumindest die Bedeutung der Namen konkreter beschreiben. GitFlow? https://www.atlassian.com/de/git/tutorials/comparing-workflows/gitflow-workflow

Vorschlag: We managed our Source Code using the Gitflow Workflow (if this is correct) and GitLab. vlt. Noch mit Bezug zum Prozess (wann integriert/deployt)

kennethenglisch commented 3 months ago

Das stimmt, das meiste kann vermutlich weg. Den Vorschlag werde ich nochmal mit der Gruppe besprechen und dann zum nächsten Release übernehmen.

Vielen Dank!

bkleinen commented 3 months ago

Das stimmt, das meiste kann vermutlich weg. Den Vorschlag werde ich nochmal mit der Gruppe besprechen und dann zum nächsten Release übernehmen.

Vielen Dank!

ok, alles klar. Dann merge ich den PR jetzt.