独自gem作成その3 / 体裁整え, README

前回の 独自gem作成では、実際のコードを書いてテスト完了し、rubocopによりraisのスタイルガイドに沿っているかチェックをしたところまでやりました🙂
本日は続きをやっていきます！

目次

１．rubocopの検証

前回の rubocop の検証では、26個のCの警告が出ているところまでやりました！
これらをひとつひとつ確認して修正していきます。

26個のCの内容と対処方法は以下のとおりです💪
重複している内容もあるので、全部で8種類でした🙂

Style/FrozenStringLiteralComment: Missing magic comment # frozen_string_literal: true.

→ # frozen_string_literal: trueと記載し、直後に空白の1行を入れる（出典 ）

Style/StringLiterals: Prefer double-quoted stringsunless you need single quotes to avoid extra backslashes for escaping.

→ ' text 'の表記を" text "に修正（出典）

Style/UnneededPercentQ: Use %q only for strings that contain both single quotes and double quotes.

→ %q{ text }の表記を" text "に修正（出典）

Style/HashSyntax: Use the new Ruby 1.9 hash syntax.

→ ハッシュの記法を Ruby1.9 以降のものに修正（出典）

Layout/SpaceInsideParens: Space inside parentheses detected.

→ ( calc )の中にある余計なスペースを削除（出典）

Layout/TrailingBlankLines: Final newline missing.

→ 最終行に空白行を追加（出典）

Layout/SpaceAroundOperators: Operator = should be surrounded by a single space.

→ =の前後に連続しているスペースを1つにする（出典）

Layout/SpaceInsideBlockBraces: Space between { and | missing.

→ {| text | } の { の後にスペースを1つ入れる（出典）

これらをひとつひとつ修正しました😊

２．READMEを記述

公開する前に、README.mdに gem に関する情報を書いておきます。
コードではなく、人にわかるように文章を書きます💡ここに書いておくと、他の方が README を読んで、どんな gem なのか知ることができます✨
デフォルトでは以下のような状態です。

これを自分なりに書いていきます。

ここまでできたら無事公開！のはずですが…
Githubの使い方わからないので、一旦Githubの勉強を挟みます🙏
道のりは長い😂