BSS Style

This repository exists to standardize our linter configurations so that they can propagate to our repositories.

Installation

Add this line to your application's Gemfile:

gem 'bss_style'

And then execute:

$ bundle

Usage

RuboCop Configurations

To include the configurations from this repository in your project, add a line like this as the only content in your .rubocop.yml:

inherit_gem:
  bss_style: rubocop/default.yml

Development

After checking out the repo, run bin/setup to install dependencies. 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.

Deployment

  1. Update the gem version in lib/bss_style/version.rb using Semantic versioning.
  2. Commit and push your changes.
  3. Run bundle exec rake release to deploy the new gem version to RubyGems.org.

Contributing

Bug reports and pull requests are welcome on GitHub at https://github.com/big-southern-software/bss-style.