free_mutant/gems/devtools/README.md

48 lines
1.4 KiB
Markdown
Raw Permalink Normal View History

2021-01-16 23:07:52 +00:00
# devtools
[![Build Status](https://img.shields.io/circleci/project/mbj/devtools.svg)](https://circleci.com/gh/mbj/devtools/tree/master)
[![Dependency Status](https://gemnasium.com/mbj/devtools.png)](https://gemnasium.com/mbj/devtools)
[![Code Climate](https://codeclimate.com/github/datamapper/devtools.png)](https://codeclimate.com/github/datamapper/devtools)
<!-- [![Code Climate](https://codeclimate.com/github/mbj/devtools.png)](https://codeclimate.com/github/mbj/devtools) -->
Metagem to assist development.
Used to centralize metric setup and development gem dependencies.
## Installation
Add the gem to your Gemfile's development section.
```ruby
group :development, :test do
gem 'devtools', '~> 0.1.x'
end
```
## RSpec support
If you're using RSpec and want to have access to our common setup just adjust
`spec/spec_helper.rb` to include
```ruby
require 'devtools/spec_helper'
```
## Credits
The whole [ROM](https://github.com/rom-rb) team that created and maintained all
these tasks before they were centralized here.
## Contributing
* Fork the project.
* Make your feature addition or bug fix.
* Add tests for it. This is important so I don't break it in a
future version unintentionally.
* Commit, do not mess with Rakefile or version
(if you want to have your own version, that is fine but bump version in a commit by itself I can ignore when I pull)
* Send me a pull request. Bonus points for topic branches.
## License
See `LICENSE` file.