Welcome to PatchFest Automations! This repository contains small automation scripts, GitHub Actions samples, Docker setups, CI helper tools, templates, and intentionally buggy code designed for contributors to patch during PatchFest.
scripts/ → Python + Bash automation scripts actions/ → GitHub Actions workflow samples docker/ → Dockerfiles & Docker Compose examples ci/ → Linter, formatter, and CI support scripts templates/ → CLI and automation templates tests/ → Unit tests revealing bugs docs/ → Guides and documentation .github/ → Issue templates & CI configuration
- Fork this repository.
- Create a new branch:
git checkout -b fix/<short-description>
- Make your changes. Good PatchFest contributions include: -> Fixing failing tests -> Patching buggy automation scripts -> Improving GitHub Actions workflows -> Enhancing Docker configurations -> Updating CI support scripts -> Improving or extending templates -> Adding missing documentation
- Run tests pytest -v
- Commit your changes git add . git commit -m "fix: "
- Push your branch and open a Pull Request.
scripts/ — broken automation logic in Python/Bash actions/ — incomplete or failing GitHub Actions examples docker/ — Dockerfiles needing fixes or optimizations ci/ — formatting/lint helpers with issues templates/ — CLI scaffolds needing improvements tests/ — unit tests designed to fail until patched
Use the tests in the tests/ directory to guide your fixes.
Detailed guides are provided in the docs/ directory: ->Automation overview ->How to run scripts ->Docker usage guide ->CI pipeline documentation
If your patch involves Docker automation: docker build -t patchfest . docker run -it patchfest
-> Keep patches small and focuseds -> Fix one issue per pull requests -> Follow existing coding conventionss -> Do not break the CI workflows -> Update documentation when modifying behaviors