zig/exercises
1
0
Fork 1
mirror of https://codeberg.org/ziglings/exercises.git synced 2025-09-20 22:55:38 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

Merge pull request 'Added instructions for patch files' (#297) from gollum into main

Browse Source 
Reviewed-on: https://codeberg.org/ziglings/exercises/pulls/297
This commit is contained in:
Chris Boesch 2025-08-24 16:27:03 +02:00
parent 7488727625 c36fe8007d
commit b3178e81a8
1 changed files with 22 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
CONTRIBUTING.md
View File

@ -51,6 +51,7 @@ downloads page.
If you run into an error in Ziglings caused by breaking changes If you run into an error in Ziglings caused by breaking changes
in the latest development build of Zig, that's a new bug in in the latest development build of Zig, that's a new bug in
Ziglings. Please file an issue...or make a pull request! Ziglings. Please file an issue...or make a pull request!
For the latter, also read "The Secrets” section.
## Formatting ## Formatting
@ -89,3 +90,24 @@ contribution for any other purpose.
If you want to peek at the secrets, take a look at the `patches/` If you want to peek at the secrets, take a look at the `patches/`
directory. directory.
Every Ziglings exercise contains mistakes on purpose.
To keep our automated tests happy, each exercise also
has a patch in `patches/healed` that “heals” it.
When you change an exercise, you’ll usually need to update
its patch too. That’s where our little helper Gollum comes in:
1. In the project root, create a folder called answers/.
2. Put your solved version of the exercise file in there.
3. Back in the root, run:
`./patches/gollum <exercise-number>`
For example: ./patches/gollum 106
This will generate a shiny new patch.
Double-check everything by asking the magical Eowyn:
`./patches/eowyn`
If all tests pass: 🎉 You’re done!
Don’t forget to commit the patch file.