AlpineLab code style¶ ↑
Code style used by AlpineLab in all our projects.
Usage¶ ↑
-
Add those gems to your
Gemfile
(orgems.rb
, orgems.deps.rb
):group :development, :test do gem "alpinelab-codestyle", "~> x.y", require: false gem "rubocop", "~> x.y", require: false gem "rubocop-md", "~> x.y", require: false end
or install them manually:
gem install alpinelab-codestyle rubocop rubocop-md
-
Create or prepend your Rubocop configuration (usually
.rubocop.yml
) with:inherit_gem: alpinelab-codestyle: - config/default.yml - config/rails.yml # for Rails projects only
Best practices¶ ↑
Some conventions are adopted and enforced, but cannot be translated as Rubocop rules (or are not supposed to). You will find those conventions as Markdown files in the {docs
} directory of this project, organized by subject:
Releases¶ ↑
To release this very gem:
-
Bump its version number in {
version.rb
} respecting Semantic Versioning 2 -
Use Bundler Rake task to build, tag and push the gem:
rake release
(using Docker, both [Git authentication] and [Rubygems authentication] must be configured to run
docker-compose run app rake release
)
License¶ ↑
This project is developed by Alpine Lab and released under the terms of the MIT license.
