Contributing

Thanks for contributing to Tigerlings!

Exercise Guidelines

Exercise file names should start with a number and have a name that at least loosely describes what is being taught.
Each exercise should ideally teach one concept.
Exercises should be standalone and should not interact with one another (aside from depending on a running TigerBeetle cluster).
Exercises should fail and exit with a non-zero error code.
Let's make them fun!

Adding Exercises

To add a new Tigerlings exercise:

Write the (failing) exercise as a bash script in exercises.
Run chmod +x exercises/*.sh to make your script executable.
Add to the What's Covered list in the main README.
Create a commit with that exercise.
Fix the exercise so that it passes and returns a status code of 0.
Run the tools/patches_generate.sh script.
Use git add patches && git commit --amend to add the patch file to your commit.
Run tools/patches_revert.sh to revert the fix.
Submit a pull request with your new exercise.