Are you sure you want to delete the question?

Leaving a resolved question undeleted may help others!

「リファクタリング(refactoring)」の略称

Discussion

Closed

「リファクタリング」の良い略称を探しています。

コミットメッセージにて「リファクタリングのコミットである」ことを簡単に示すことが目的です。

現状、思いついているのはrefac:, refact:です。
fix:はどうしてもバグ修正と重なりますし、それ以外には思いつきません。

何か良いアイデアや、慣習・文化的に使い慣れている方法があればぜひ教えていただきたいです。

追記:ref:について記述し忘れていました。
refreferenceの略語として使われることがあまりにも多く、refactoringの略語として使用するのは不適切かなと考えています。(コミットメッセージという文脈であっても)
この点についてもご意見いただきたいです。

0

「git commit 接頭辞」などで検索すると例が色々と出てきますが、refactor が多いようです。

ref は "参照 (reference)" が一般的なので避けた方が無難です。

1Like

@midoribi @cubick
ありがとうございます。ちょうど今refについて追記させていただきました。
やはりreferenceを想起させてしまう点がネックですね・・・
refactorなるほど。長いように感じますが、万人に伝わるという点では良いのか。

0Like

Conventional Commitsではrefactorが紹介されていますね。

fix: や feat: 以外の 型 も許されています。たとえば @commitlint/config-conventional (これは Angular の規約 が基になっています) は build:, chore:, ci:,docs:, style:, refactor:, perf:, test:, などを推奨しています。

元になっているAngularの規約では次のようにあります。

refactor: A code change that neither fixes a bug nor adds a feature

少々長いと感じるかもしれませんが、短すぎるとやはりreferenceを想起させますし、VS Codeでは拡張機能を使うことで仕様に沿ったコメントを書きやすくなります。
image.png

参考

1Like

「リファクタリング」の良い略称を探しています。

どういう理由でそういうことを聞いているのか分かりませんが、あなたが言う、

万人に伝わる

ということが重要なら、リファクタリングとか聞いたこともない人でも分かるように、ググれば即出てくる「リファクタリング」のままにするという話になると思いますが?

現状、思いついているのはrefac:, refact:です。

「refac: のコミット」とか言われても少なくとも私には通じません。ひょっとして refac: というのを自分が知らないだけかと思って、ググって調べるということはするにしてもやはり意味不明で、この人は話が通じない人だと思うだけです。

質問者さんの属する組織内での話であれば、組織内で話し合って決めればいい話で、赤の他人しかいない Q&A サイトで聞く話ではないです。

0Like

@SurferOnWww
コメントありがとうございます。
私としては気になったことについての意見交換を楽しんでおり、ずいぶん攻撃的なコメントをいただいたなと驚いております。
目的については本文で説明しております。
当方未経験なもので、組織には属しておりません。組織に属していれば組織で話し合います。
これは質問ですが意見交換でもあります。
回答をそのまま鵜呑みにして実行するのでは、とご心配頂いたのかもしれませんが、そのようなことはいたしません。

さて、refac:についてのご意見ありがとうございます。
「リファクタリング」が良いというご意見ですね。
個人的には、英語の接頭辞で統一したいと思いますので、refactor:にしようかと思います。

0Like

略称にする必要性がわからないけど,
"refactoring" -> "refactor" じゃあまり短くなってない感.(そこまで書くなら最後の "ing" まで書けばいいのでは感,みたいな)
(個人で意味が分かればいいだけの話ならば "[R]" とか "(R)" みたいなのでも良いのかも??)

0Like

@NyancoRitter コメントありがとうございます!

refactorはそこまで短くなっていないという意見は、たしかに私も同様に思うところです。

ただ、体系化された仕様であるConventional Commitsで使用されているということで、私もそれに倣おうかと思っております。

(こちらの質問は、少し前にクローズしました。タッチの差でコメントしていただけたのだと思いますが、返信ができないかもしれません。ご了承ください。)

0Like

英語で統一とは残念なり。構造改革を提案しようと思っていたのに。それはともかく、思い切った造語でもいいのではないでしょうか。Gameの魔法とか技でそれらしい効果のものをもじってみるとか。受けが良ければ業界標準になるくらい普遍的になる可能性も…。reformは短くて良さげかも

1Like

@mashuel
構造改革・・・造語・・・確かに・・・
従来のfix:等に合わせる目的で「英語で統一」としましたが、視野狭窄とも言えますね。
考えてみます。ありがとうございます。

0Like

Your answer might help someone💌