Ribose OSS Utils

This is a collection of utilities supporting the creation and maintenance of Ribose open source projects.

Installation

Currently, there is no installation instruction except to copy and paste the files to $PATH and running chmod +x on them.

This is expected to change once there’s a clearer understanding of how these utilities should be maintained.

TODO: Need a way to organize these files.

Usage

TODO: Move these instructions into their respective README files.

Creating a new open source Ruby gem

> create_opensource_gem "${your_gem_name}"
Installing bundler... 2.0.1
Creating gem... OK
Installing .gitignore... OK
Converting markdown files to asciidoc... OK
Preprocessing LICENSE.txt... OK
Preprocessing README.adoc... OK
Preprocessing CODE_OF_CONDUCT.adoc... OK
Preprocessing gemspec contacts... OK
Preprocessing README.adoc... OK
Preprocessing .travis.yml... OK
Preprocessing gemspec repos... OK
Preprocessing gemspec bundler version... OK
Installing GitLab CI configuration... OK
Installing Rubocop... OK
Installing Hound... OK
Installing Editorconfig... OK
Installing Simplecov... OK
Running 'bundle' to prepare for binstub installation... OK
Installing binstubs for rake... OK
Installing binstubs for rspec... OK
Autofixing Ruby files... OK

🥳  Gem created
✍️  Remember to update your gem's summary and description in ${your_gem_name}.gemspec

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/riboseinc/ribose-oss-utils. 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.

Code of Conduct

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