Project

github_contributions

0.0
No release in over a year
github_contributionskevinjalbert/github_contributionsHomepageDocumentationSource CodeBug TrackerWiki
Gem that provides can fetch your GitHub contributions and output them
2005
2006
2007
2008
2009
2010
2011
2012
2013
2014
2015
2016
2017
2018
2019
2020
2021
2022
2023
2024
 Popularity
Downloads
2,219
Stars
6
Forks
0
Watchers
2
 Releases
Current version
0.1.1
Total releases
2
First release
2022-03-01
Latest release
2022-03-01
 Pull Requests
Open Pull Requests
0
Closed Pull Requests
0
Merged Pull Requests
1
Pull Request Acceptance Rate
100%
 Development
Primary Language
Ruby
Licenses
MIT
Average date of last 50 commits
2022-02-28
Reverse Dependencies
0

 Dependencies

Development

rake
>= 13.0

Runtime

activesupport
>= 7.0
bundler
>= 2.3
chronic
>= 0.10
hashie
>= 5.0
octokit
>= 4.22
 Project Readme

GitHub Contributions

Ever wanted to know where you (or someone else) are making contributions on GitHub?

Your GitHub profile shows you the Contributions Calendar and Contribution activity, which both provide great visualizations and details covering contributions of the following:

  • creating/closing issues
  • creating/closing/merging/reviewing pull requests
  • creating repositories
  • authoring commits on the main branch of repositories
  • starting/answering discussions

I personally wanted to track comments on issues and pull requests as I felt they were a good indication of contributions. It sometimes isn't uncommon for a lot of discussions to happen on issues or even a pull request.

I am a fan of Obsidian right now to track my day at work. Recording these contributions in GitHub makes it simple to recall what I did in previous days/weeks. This is even more important if you have a BragDoc. As Obsidian uses Markdown, that is the primary format that this tool is built for.

Install

gem install github_contributions

You need a GitHub Personal Access Token in your ENVs as GITHUB_ACCESS_TOKEN for this gem to work.

Usage

# Show me contributions for 'kevinjalbert' for today
github_contributions -a "kevinjalbert"

# Show me contributions for 'kevinjalbert' for today only in the 'shopify' org
github_contributions -a "kevinjalbert" -o "shopify"

# Show me contributions for 'kevinjalbert' in the last week
github_contributions -a "kevinjalbert" -s "last week"

# Show me contributions for 'kevinjalbert' for the week before last
github_contributions -a "kevinjalbert" -s "two weeks ago" -e "one week ago"

# Show me contributions for 'kevinjalbert' for only yesterday
github_contributions -a "kevinjalbert" -s "yesterday" -e "yesterday"

# Help
github_contributions -h

Contributions are grouped by their pull request or issue in order of creation time. This ends up producing a rather detailed list of where contributions were made in the specified time frame. Links are present to easily allow you to jump directly to the contribution. Everything is displayed in Markdown, ready to be copy/pasted where desired. The following is an example of what the output looks like: