BeginningOpenSource
A tool to find beginner friendly open source issues to work on.
###Other resources for finding beginner friendly open source projects:
http://24pullrequests.com/projects
https://contribulator.herokuapp.com/?language=Ruby
https://blog.newrelic.com/2014/05/05/open-source_gettingstarted/
https://www.youtube.com/watch?v=IXnNgLmd6BM
https://www.youtube.com/watch?v=0OQg42gSol4
https://guides.github.com/activities/contributing-to-open-source/
https://www.quora.com/How-can-I-contribute-to-open-source-software
https://changelog.com/nightly/
http://www.firsttimersonly.com/
Installation
Add this line to your application's Gemfile:
gem 'beginning_open_source'
And then execute:
$ bundle
Or install it yourself as:
$ gem install beginning_open_source
Usage
type beginning-open-source into the command line to execute the program
Development
NOTE: Unless you provide a github token to authenicate, your search results will only return repository descriptions and stars once per hour due to github api restrictions". Please only generate a public token as this application only accesses public data. Instructions to generate a github token are here: https://help.github.com/articles/creating-an-access-token-for-command-line-use/ . When developing, you can paste your username and public token into the secrets.rb file.
After checking out the repo, run bin/setup
to install dependencies. Then, run rake spec
to run the tests. You can also run bin/console
for an interactive prompt that will allow you to experiment.
To install this gem onto your local machine, run bundle exec rake install
. To release a new version, update the version number in version.rb
, and then run bundle exec rake release
, which will create a git tag for the version, push git commits and tags, and push the .gem
file to rubygems.org.
Contributing
Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/beginning_open_source. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the Contributor Covenant code of conduct.
License
The gem is available as open source under the terms of the MIT License.