prefer-make

Make を使用したビルド

このプロジェクトでは Makefile を使用します。go コマンドを直接実行するより、常に make のターゲットを優先してください。

ルール

1. go build、go test、go run、go vet、go fmt、または golangci-lint コマンドを実行する前に、必ず Makefile を確認してください。対応するターゲットがあるか調べます。
2. 生の go コマンドではなく、Makefile のターゲットを使用してください。たとえば、以下のとおりです。
   • go build ./... ではなく make build
   • go test ./... ではなく make test
   • golangci-lint run ではなく make lint
   • go run main.go ではなく make run
   • go fmt ./... ではなく make fmt
3. make help を実行してターゲットを確認してください。失敗した場合は、Makefile を直接読みます。
4. タスクに関連する Makefile のターゲットがない場合に限り、生の go コマンドを使用してください。

検証手順

1. 実行前に、make help の出力または Makefile を確認し、ターゲットが存在することを確認します。
2. 実行後に、コマンドがステータス 0 で終了し、期待どおりの出力が得られたことを確認します。

よくある間違いと注意点

• 確認せずにターゲット名を決めつける。 make unit-test があると推測しないでください。Makefile を確認します。ターゲット名はプロジェクトによって異なります。
• すでにフラグを設定している make ターゲットに、フラグを追加する。 たとえば、Makefile がすでに -race を渡しているのに、make test ARGS="-v -race" を実行するケースです。フラグを追加する前に、ターゲットの処理内容を確認してください。
• Makefile にパッケージ引数を受け付けるターゲットがあるのに、サブセットに対して生の go test ./specific/pkg/... を実行する。 （例：make test PKG=./specific/pkg/...）