From d2498f4c4a427654f34b4347b029275293a2f97e Mon Sep 17 00:00:00 2001 From: rito528 <39003544+rito528@users.noreply.github.com> Date: Sun, 22 Sep 2024 15:37:46 +0900 Subject: [PATCH] =?UTF-8?q?style:=20CONTRIBUTING.md=20=E3=81=AB=20format?= =?UTF-8?q?=20=E3=82=92=E9=81=A9=E7=94=A8?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- CONTRIBUTING.md | 27 ++++++++++++++------------- 1 file changed, 14 insertions(+), 13 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 765ca464..f4679879 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -36,7 +36,8 @@ rustup target add x86_64-unknown-linux-musl ### ローカルで起動する -データベース周りの接続情報は [.env.example](./server/.env.example) にまとまっており、 DB を起動するためには `.env` ファイルが必要なため、ファイルをコピーします。 +データベース周りの接続情報は [.env.example](./server/.env.example) にまとまっており、 DB を起動するためには `.env` +ファイルが必要なため、ファイルをコピーします。 必要に応じて値を書きかえてください。 データーベースとサーバーを起動するにはリポジトリのディレクトリトップで `up` タスクを実行します。 @@ -111,22 +112,22 @@ axum とユースケースをつなぐハンドラーを実装するクレート ### リポジトリのディレクトリトップで使えるタスク -| タスク名 | 実行されるタスク | 備考 | -| :--------: | :--------------------: | :---------------------------------- | -| up-db | docker compose up -d | データベースを立ち上げます | +| タスク名 | 実行されるタスク | 備考 | +|:----------:|:----------------------:|:------------------------| +| up-db | docker compose up -d | データベースを立ち上げます | | run-server | cd server && cargo run | server/app をビルドして立ち上げます | -| up | up-db -> run-server | 上記 2 つを順番にやってくれます | +| up | up-db -> run-server | 上記 2 つを順番にやってくれます | ### cargo ワークスペース共通で使えるタスク cargo ワークスペースで共通のタスクはワークスペースのトップディレクトリで実行すると、すべてのクレートに対してタスクが実行されます。 各クレートのディレクトリのトップで実行すると各クレートに対してタスクが実行されます。 -| タスク名 | 実行されるタスク | 備考 | -| :------: | :---------------------------------------------: | :------------------------------------------------------------- | -| fix | cargo clippy --fix --allow-dirty --allow-staged | clippy が自動でコードを修正します | -| test | cargo nextest run | nextest によるテストの実行を行います | -| lint | cargo clippy -- -D warnings | clippy によるコードチェックを行います | -| format | cargo fmt | rustfmt によるコード整形を行います | -| pretty | fix -> test -> lint -> format の順に実行します | 上記 4 つをすべて実行します、push の前に行うことが推奨されます | -| generate-migrate-file <ファイル名> | sea-orm-cli migrate generate <ファイル名> | sea-orm-cliによるデータベースマイグレーションファイルを生成します。 | +| タスク名 | 実行されるタスク | 備考 | +|:-----------------------------:|:-----------------------------------------------:|:----------------------------------------| +| fix | cargo clippy --fix --allow-dirty --allow-staged | clippy が自動でコードを修正します | +| test | cargo nextest run | nextest によるテストの実行を行います | +| lint | cargo clippy -- -D warnings | clippy によるコードチェックを行います | +| format | cargo fmt | rustfmt によるコード整形を行います | +| pretty | fix -> test -> lint -> format の順に実行します | 上記 4 つをすべて実行します、push の前に行うことが推奨されます | +| generate-migrate-file <ファイル名> | sea-orm-cli migrate generate <ファイル名> | sea-orm-cliによるデータベースマイグレーションファイルを生成します。 |