Have you been looking for open source repositories to contribute? Look no further! You have come to right place. This gem will find active repositories from github to eat away your weekend time. Say goodbay to fruitless late night research, tiring click surfing and the voice in your head which make you feel guilty for not doing enough. Be warned! Your life will never be same after you have installed this gem. We offer all these unbelievbale features at a never before price of FREE! FREE! FREE! Why are you still waiting? Get your terminals rolling, install this gem and experience the change.
βDisclaimer: This gem is WIP. We will be adding exciting features like sorting repos by most newcomer issues and active pulse. Until then you should have a look at π http://up-for-grabs.net/#/
Installation π
Add this line π to your application's Gemfile:
gem 'contribute'
And then execute:
$ bundle
Or install it yourself as:
$ gem install contribute
Usage π±
You will need your api access token. π Github people have written about how can you get those magic bits.
Rename .token.yml.exmaple
to .token.yml
.
cp .token.yml.example .token.yml
Replace your_github_token
in .token.yml
with your github token.
Look at the stars, Look how they shine for you
You can chain various options. For example, following command will return repos with primary language ruby and whose stars are between 1000 and 5000:
Contribute::Finder.new.language("ruby").stars(1000,5000).find
You can also use any search string as per π github documentation to find repos.
Contribute::Finder.new("language:ruby").find
Finding repos π
You can filter out repo of your interest using following methods:
forks
stars
langauge
Sorting and ordering π
Sort repos by calling sort_by
. Call order
with desc
or asc
to order your repos in descending and ascending order respectively.
# valid option for sorting: created, updated, stars, forks
Contribute::Finder.new("language:ruby").sort_by('stars').order('asc').find
Use Contribute::ExtendedSort
module if you would like sort by name, size, watchers and issues.
repos = Contribute::Finder.new("language:ruby").find
Contribute::ExtendedSort.sort_by!(repos, 'size')
Development π»
Omg Stranger! You are very kind for reading this. Contribute needs you! Get your environment loaded with all the gems you will need in your journey ahead:
# In side contribute folder
$ pwd
/home/addie/contribute
# Install dependencies
$ bundle install
Make changes to code and test it in terminal:
# Load copy of your gem in your irb
$ irb -Ilib -rcontribute
2.3.1 :001 > Contribute::Finder.new('language:ruby').find
Take at look at π our issues board.
License π
The gem is available as open source under the terms of the π MIT License.