Skip to content

Contributing貢献

The usual process to make a contribution is to:貢献を行うための通常のプロセスは次のとおりです：

  1. Check for existing related issues既存の関連する問題を確認する
  2. Fork the repository and create a new branchリポジトリをフォークして新しいブランチを作成する
  3. Make your changes変更を加える
  4. Make sure formatting, linting and tests passes.フォーマット、リント、テストが通過することを確認する。
  5. Add tests if possible to cover the lines you added.追加した行をカバーするために可能であればテストを追加する。
  6. Commit, and send a Pull Request.コミットし、プルリクエストを送信する。

Clone the repositoryリポジトリをクローンする

Clone the hatch repository, cd into it, and create a new branch for your contribution:hatch リポジトリをクローンし、cd で移動して、あなたの貢献のための新しいブランチを作成します:

cd hatch
git switch -c add-my-contribution

Run the testsテストを実行します

Run the test suite while developing:開発中にテストスイートを実行します:

hatch test

Run the test suite with coverage report:カバレッジレポート付きでテストスイートを実行します:

hatch test --cover

Run the extended test suite with coverage:カバレッジ付きで拡張テストスイートを実行します:

hatch test --cover --all

Lintリンティング

Run automated formatting:自動フォーマットを実行します:

hatch fmt

Run full linting and type checking:完全なリンティングと型チェックを実行します:

hatch fmt --check
hatch run types:check

Docsドキュメント

Start the documentation in development:開発中のドキュメントを開始します:

hatch run docs:serve

Build and validate the documentation website:ドキュメントウェブサイトをビルドして検証します:

hatch run docs:build-check