What's an easy way to have fun, and celebrate an open source Halloween? Open source trick or treating, of course! The repository and interface here is our trick or treat bag that we've discovered across the open source landscape. You can add candy for your open source project here too! Each candy can be customized for a specific open source project:
And each is explorable:
This is a low impact way to have some fun with Halloween for your open source project without burdening maintainers.
- Generate a candy for your repository with the candy generator
- Take a screenshot of your candy, tight around the edges!
- Save it somewhere in your repository named "open-source-halloween-2021.png" (or the current year for the future)
And that's it! The interface here runs a nightly job to search for these files, meaning that if GitHub has indexed it, it should show up. If you run into any issues with the generator please [open an issue, or even better, a pull request with your suggested changes.
If you see any candy that violates GitHub's terms of service please report the repository to GitHub, and also open an issue here to remove the file.
🦇️ View the Treat Bag 🦇️
or if you haven't generated a candy for your repository yet:
🍬️ Generate your Candy! 🍬️
The instructions here are for running the generator locally.
First install requirments:
python -m venv env
pip install -r requirements.txtYou'll need to export a personal access token as GITHUB_TOKEN:
export GITHUB_TOKEN=xxxxxxxxxxxTime to go trick or treating!
python trick-or-treat.pyThis should be run nightly to update the candy here.