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.

  1. Fork the repository
    Click the β€œFork” button on the top right to create your own copy.

  2. Create a branch
    ```bash git checkout -b idea/debugging-nightmares

Use a descriptive name (idea/..., art/..., fix/...).

  1. 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
  2. Commit and push

    git commit -m "Added new idea: debugging nightmares"
    git push origin idea/debugging-nightmares
    
  3. 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.