gh_coab

GhCoab

This is a very simple gem. It helps you get the "Co-authored-by" text to add a co-author to a commit. You call the method in your terminal gh_coab s -u <GITHUB_USERNAME> and the gem does an api call to the public events of the author to find emails associated with it.

Installation

Install the gem and add to the application's Gemfile by executing:

$ bundle add gh_coab

If bundler is not being used to manage dependencies, install the gem by executing:

$ gem install gh_coab

Usage

gh_coab s -u <GITHUB_USERNAME>

Development

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 the created tag, and push the .gem file to rubygems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/[USERNAME]/gh_coab. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

License

The gem is available as open source under the terms of the MIT License.

Code of Conduct

Everyone interacting in the GhCoab project's codebases, issue trackers, chat rooms and mailing lists is expected to follow the code of conduct.