Skip to content

Commit

Permalink
style: CONTRIBUTING.md に format を適用
Browse files Browse the repository at this point in the history
  • Loading branch information
@rito528
rito528 committed Sep 22, 2024
1 parent cb40aff commit d2498f4
Showing 1 changed file with 14 additions and 13 deletions.
27 changes: 14 additions & 13 deletions CONTRIBUTING.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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` タスクを実行します。
Expand Down Expand 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によるデータベースマイグレーションファイルを生成します。 |

0 comments on commit d2498f4

Please sign in to comment.