Making the T-shirt puns work!
Made with ❤️ by the SciPy Conference Organizers.
pip install scipyconference
The idea behind this package is to collectively create and serve our own puns! We want to make it super simple and easy for people to contribute. We envision this as something that somebody could use to load historic puns from various SciPy conference archives that people submit and create at the conference.
Our goal is to maintain minimal dependencies and scaffolding to ensure we can get as many contributions as possible while keeping the barrier to entry low.
Contributing new puns is simple! Just edit the scipyconference/puns.json
file and add your pun to the collection. The file contains a JSON array of pun objects - add yours following the same format.
Adding your GitHub handle for pun attribution is optional.
To contribute new puns:
- Fork this repository on GitHub
- Clone your fork locally:
git clone [email protected]:YOUR_USERNAME/puns-scipyconference.git cd puns-scipyconference
- Create a new branch for your puns:
git checkout -b add-my-puns
- Edit
scipyconference/puns.json
with your favorite editor:# Using nano nano scipyconference/puns.json # Using vim vim scipyconference/puns.json # Using emacs emacs scipyconference/puns.json
- Save your changes, and then commit and push your changes:
git add scipyconference/puns.json git commit -m "Add new puns for SciPy conference" git push origin add-my-puns
- Create a pull request from your fork's
add-my-puns
branch to the main repository'smain
branch