imskr / contributions-badge

Showcase your number of open-source merged pull requests in profile's README dynamically

contributions-badge

A github action workflow for showcasing your number of merged pull requests in profile's README dynamically

---

Usage

1. Go to your repository

2. Add the following to your README.md file, you can use any title. Just make sure that you use <!-- MERGED_PULL_REQUESTS_COUNT --><!-- MERGED_PULL_REQUESTS_END --> in your readme. The workflow will replace this comment with the number of merged pull requests:

   <!-- MERGED_PULL_REQUESTS_START -->
   <!-- MERGED_PULL_REQUESTS_END -->

3. Create a folder .github/workflows inside root of the repository if it doesn't exists.

4. Create a new file contributions.yml inside .github/workflows/ with the following contents or copy it from here:

5. Replace the above organization, project, platform and username with your data.
6. Commit and wait for it to run automatically, or you can also trigger it manually to see the result instantly.

Currently we are only supporting public projects on platform GitLab and GitHub

Results

See it in action here

Support