https://github.com/imskr/contributions-badge

Showcase your number of open-source merged pull requests in profile's README dynamically
https://github.com/imskr/contributions-badge

badge-generator contribution open-source readme readme-profile

Last synced: 21 days ago
JSON representation

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

• Host: GitHub
• URL: https://github.com/imskr/contributions-badge
• Owner: imskr
• License: mit
• Created: 2024-02-24T19:10:31.000Z (9 months ago)
• Default Branch: main
• Last Pushed: 2024-03-12T12:49:06.000Z (8 months ago)
• Last Synced: 2024-10-04T19:09:42.618Z (about 1 month ago)
• Topics: badge-generator, contribution, open-source, readme, readme-profile
• Language: Ruby
• Homepage:
• Size: 950 KB
• Stars: 7
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE

Awesome Lists containing this project

README

        
# 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 `` in your readme. The workflow will replace this comment with the number of merged pull requests:

    ```markdown

    

    

    ```

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](./examples/contributions.yml):

![](./public/images/workflow.png)

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

![result](./public/images/result.png)

> See it in action [here](https://github.com/imskr/imskr/tree/master?tab=readme-ov-file#-open-source-contributions)

## Support