Skip to content

Latest commit

 

History

History
64 lines (45 loc) · 2.48 KB

CONTRIBUTING.md

File metadata and controls

64 lines (45 loc) · 2.48 KB
Raw

Contributing

Bug reports and pull requests are welcome on GitLab at https://gitlab.com/oauth-xx/oauth. This project is intended to be a safe, welcoming space for collaboration, and contributors are expected to adhere to the code of conduct.

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

To submit a patch, please fork the project and create a patch with tests. Once you're happy with it send a pull request and post a message to the google group or on the gitter chat.

Create a Patch

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.

Run tests

Against Rails 6

BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle install
BUNDLE_GEMFILE=gemfiles/a6.gemfile bundle exec rake

Against Rails 7

BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle install
BUNDLE_GEMFILE=gemfiles/a7.gemfile bundle exec rake

Release

To release a new version:

  1. update the version number in version.rb
  2. run bundle exec rake build:checksum
  3. move the built gem to project root
  4. run bin/checksum to create the missing SHA256 checksum
  5. move the built gem back to pkg/
  6. 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.

NOTE: You will need to have a public key in certs/, and list your cert in the gemspec, in order to sign the new release. See: RubyGems Security Guide

Contributors

Contributors