Skip to content

annamedv/my-badges

 
 

Repository files navigation

My Badges My Badges

Welcome to My Badges!

Think of My Badges as a fun twist on GitHub's achievements. We've added a dash of humor and variety, bringing you badges that are quirky and different!

🔧 Integration is Easy!

You can effortlessly integrate My Badges into your GitHub profile. With our automatic updating action, your badges stay fresh. Whenever you unlock a new badge or the community adds a fresh one, it updates daily.

👀 Curious to see them in action?

Check out how these badges sparkle on my profile.

List of badges

a-commit ab-commit abc-commit abcd-commit abcde-commit abcdef-commit stars-100 stars-500 stars-1000 stars-2000 stars-5000 stars-10000 stars-20000 midnight-commits morning-commits evening-commits yeti star-gazer dead-commit bad-words mass-delete-commit mass-delete-commit-10k revert-revert-commit my-badges-contributor fix-2 fix-3 fix-4 fix-5 fix-6 fix-6+ chore-commit delorean

But we are planning on adding much more. Add your own badges too!

Usage

Here is how to add my badges to your profile:

  • Star this repository.
  • Create your-username/your-username repository.
  • In README.md add the following code:
<!-- my-badges start -->
<!-- my-badges end -->
  • Add the following workflow .github/workflows/my-badges.yml to your repository.
name: my-badges

on:
  workflow_dispatch:
  schedule:
    - cron: '0 0 * * *'

permissions:
  contents: write

jobs:
  my-badges:
    runs-on: ubuntu-latest
    steps:
      - name: Update My Badges
        run: npx update-my-badges ${{github.repository_owner}} --repo=${{ github.repository }}
        env:
          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
  • Start my-badges workflow, or wait for it to run automatically.

Configuration

Param ENV alias Description Default
token GITHUB_TOKEN Auth token
user GITHUB_USER Username
repo GITHUB_REPO Repository name to push badges {user/user}
data Path to JSON to generate badges. If empty, required data will be obtained from the GH API
size Badge size for README.md, px 64
dryrun Generate badges, but skip pushing to git

Contributing badges

If you want to contribute a badge:

  • Add your badge to the all-badges folder.
  • Add your badge to the index.ts file.
  • Any badge images are welcome (png, 256x256px).

Here is an example of a pull request adding a new badge.

How to test locally?

Build project with next command:

npm run build

Run main.js with next command:

node dist/main.js your-username

This command will collect your data and save it to data/your-username.json file. You can skip recollecting the data with --data flag.

node dist/main.js --data data/your-username.json

How to create a badge image?

Most of the badges are generated with AI. An example of a prompt for the AI:

A sticker of a panda, white background.

Use your favorite tool to remove the background and resize the image to 256x256px.

Ideas for badges

Feel free to grab any of these ideas and implement them:

Commit Patterns & Styles

  • weekend-warrior - For those who commit mostly on weekends.
  • caffeine-fueled - For a burst of commits at odd hours, implying lots of coffee.
  • ninja-commit - Silent commits with minimal descriptions.
  • commit-haiku - Commit descriptions that are in the format of a haiku.
  • emoji-only - For commit messages that use only emojis.
  • oops-fix - For commits that quickly follow a previous commit to fix something minor.
  • one-liner - For commits that change only one line.
  • marathoner - For long coding sessions with many commits.
  • holiday-coder - Commits made on holidays.
  • spooky-commit - Commits made on Halloween or commits with spooky-themed messages.
  • commit-celebration - Commits made on the user's birthday or GitHub anniversary.

Coding Quality & Craftsmanship

  • code-poet - For beautifully written code.
  • code-sorcerer - For intricate or complex code changes.
  • code-detective - For commits that solve difficult bugs or mysteries.
  • merge-master - For those who handle a lot of merges without conflicts.
  • no-conflict - For users who rarely have merge conflicts.

Documentation & Comments

  • comment-ninja - A lot of comments added in a commit.
  • docs-rockstar - For those who make significant contributions to documentation.
  • wiki-warrior - For contributors to the GitHub Wiki pages of repositories.

Repository & Community Engagement

  • collaborator-king - For users who have been added as collaborators on numerous repositories.
  • issue-master - For users who open a significant number of issues across repositories.
  • pr-champion - For those who have a high number of pull requests merged.
  • community-builder - For users with a high number of followers or those who contribute to popular community-driven projects.
  • fork-fanatic - For those who have forked a large number of repositories.
  • watcher - For users who watch a high number of repositories, staying updated with many projects.
  • social-butterfly - For those with a high number of interactions (comments, reactions) across GitHub.

Project & Issue Management

  • bug-buster - For users who have closed many bug-labeled issues.
  • enhancer - For users who have closed many enhancement-labeled issues.
  • milestone-mover - For users who consistently hit project milestones or participate in milestone discussions.
  • security-sentinel - Recognizing those who report security vulnerabilities through responsible disclosure.
  • roadmap-runner - For those who actively participate in project roadmaps or long-term planning discussions.

Learning & Growth

  • learning-curve - For those who regularly commit to repositories tagged with educational or tutorial topics.
  • diversity-driver - For those who contribute to repositories tagged with diversity, inclusion, or community well-being topics.

Versatility & Multitasking

  • commit-chameleon - For users who often change the style or language of their code.
  • timezone-hopper - For those who commit at varied hours, implying they might be traveling or working across time zones.
  • triple-threat - For users who open issues, commit code, and review pull requests consistently.
  • dual-language-dynamo - For those who commit in at least two different programming languages consistently.

Contributions & Role

  • repository-ronin - For users who don’t own repositories but contribute significantly to others.
  • feedback-friend - For users who comment constructively on issues and pull requests.
  • open-source-orchestrator - For those who have initiated or lead popular open-source projects.

Miscellaneous & Fun

  • theme-thinker - For users who frequently switch or customize their GitHub UI themes.
  • bot-buddy - Users who integrate or collaborate with bots for automated checks or messages.
  • first-timer - Celebrating someone's first commit to a project.
  • no-tests - No tests added or changed in the commit.
  • ancient-code - For updating or working with very old code repositories.
  • sleepy-coder - For commits made in the very early hours of the morning.
  • streaker - For users with long daily commit streaks.

As always, these badges should be designed and implemented in a way that promotes positivity and inclusivity within the GitHub community.

License

MIT

About

All You Badges

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • TypeScript 91.5%
  • JavaScript 8.5%