Please follow these Steps & Guidelines for your Pull Request:
Before you Open the Pull Request Check and Tick these Boxes:
[x] Before you open the PR, make sure that the hugo site build works and check the result visually.
[x] Before you open the PR, 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.
[] 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)
[] 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 consistently fail to do so, I may simply reduce the file sizes brute force using
the script above - WITHOUT CHECKING THE QUALITY
[] if everythings seems fine, request a review by bkleinen on github. (on the upper right)
Fill out this Information:
Change the PR Title to: (e.g. B0 - update techstack.md) and describe your changes:
URL of your Preview Site Containing the Changes:
When did your Project Supervisor review your changes? (Date/Note or require review for PR):
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:
Opening a Pull Request to Update your Project
Please follow these Steps & Guidelines for your Pull Request:
Before you Open the Pull Request Check and Tick these Boxes:
[x] Before you open the PR, make sure that the hugo site build works and check the result visually. [x] Before you open the PR, 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. [] 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) [] 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 consistently fail to do so, I may simply reduce the file sizes brute force using the script above - WITHOUT CHECKING THE QUALITY
[] if everythings seems fine, request a review by bkleinen on github. (on the upper right)
Fill out this Information:
Change the PR Title to: (e.g. B0 - update techstack.md) and describe your changes:
URL of your Preview Site Containing the Changes:
When did your Project Supervisor review your changes? (Date/Note or require review for PR):
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:
More Information
Best Practices for Pull Requests
Documentation in README.MD and /doc