Contributing to The CodeLores
Thanks for your interest in contributing to The CodeLores — a tech comic about coding, debugging, and developer life! 🎉
We welcome ideas, jokes, scripts, and artwork. Here’s how you can join in.
🚀 How to Contribute
🛠 Prerequisite: You’ll need Git installed and a GitHub account.
-
Fork the repository
Click the “Fork” button on the top right to create your own copy. -
Create a branch
```bash git checkout -b idea/debugging-nightmares
Use a descriptive name (idea/..., art/..., fix/...).
-
Add your contribution
Contribution type Folder Example filename Comic idea (text) /ideas/debugging-nightmares.md Draft / Artwork /drafts/character-sketch.png Final Comic Strip /comics/comic-005-bug-fix-battle.png -
Commit and push
git commit -m "Added new idea: debugging nightmares" git push origin idea/debugging-nightmares -
Open a Pull Request (PR)
- Go to the original repo
- Click New Pull Request
- Describe your contribution briefly
✅ Contribution Rules
- Keep content aligned with coding humor + learning
- Credit yourself in your PR (for shoutouts)
- Respect the project branding (The Codelores)
- Don’t upload content you don’t own (no plagiarism)
- No commercial use — this project is licensed under CC BY-NC 4.0
- Please read our Code of Conduct
📄 Idea Format
When adding an idea in /ideas/:
- Title: Short and catchy
- Premise: 2–3 lines
- Punchline: The joke / twist
📢 Recognition
- All merged contributions appear in the GitHub Contributors list
- Contributors will be credited when strips are shared on LinkedIn / other platforms
💡 Questions?
Open an Issue if you have an idea but aren’t sure how to implement it.