TODO: ここに myproject の解説を記載します。
TODO: インストール方法を記載します。
TODO: ユーザー向けの使用方法を記載します。
graph TD
A[Roleの設定]
subgraph "プロジェクトの初期設定"
B1[リポジトリのクローン]
B2[リポジトリ名を変更]
B3[pyproject.tomlの変更]
end
subgraph "開発環境の構築"
C1[Poetryのインストール]
C2[依存関係のインストール]
C3[pre-commitの設定]
C4[テストの実行]
end
D[初回コミット]
A --> B1
B1 --> B2
B2 --> B3
B3 --> C1
C1 --> C2
C2 --> C3
C3 --> C4
C4 --> D
Developer, Reviewer, Merger の 3 つの役割にメンバーを割り当てます。
このリポジトリをクローンします。
リポジトリ名に合わせて以下の手順で変更します。 以下では yourproject というリポジトリ名に変更する手順を示します。
# myproject-template ディレクトリを yourproject に変更します。
mv myproject-template yourproject
cd yourproject
# .git ディレクトリを削除する
rm -rf .git
# myproject という文字列を検索して全て yourproject に置換する。
grep -rl 'myproject' . | xargs sed -i 's/myproject/yourproject/g'
# myproject という文字列を全て yourproject に置換する。
/usr/bin/find . -depth -name '*myproject*' | while read f; do mv "$f" "$(dirname "$f")/$(basename "$f" | sed 's/myproject/yourproject/g')"; done
git init
rm -rf docs/*
rm poetry.lock
rm LICENSE
Python のバージョンや、初期バージョンを修正します。
開発環境の構築の章を参照してください。
初回コミットを実施します。方法はこのページ末尾の資料を参照して下さい。
-
Poetry のインストール:
- Poetry は Python の依存関係管理ツールです。以下のコマンドでインストールできます。
curl -sSL https://install.python-poetry.org | python3 -
-
プロジェクトのクローン:
- プロジェクトをローカルにクローンします。
# git clone <リポジトリのリモートの URL> cd myproject
-
依存関係のインストール:
- Poetry を使用してプロジェクトの依存関係をインストールします。
poetry install
-
pre-commit の設定:
pre-commit
を使用して、コミットするたびにテストやコードフォーマットが行われるようにします。このため、初回に以下のコマンドを実行して設定します。
poetry run pre-commit install
-
テストの実行:
- プロジェクトのテストを実行して、全てが正常に動作しているか確認します。
poetry run pre-commit
開発メンバーは以下の役割を担当します。
- Developer: 機能や修正の開発を行います。
- Reviewer: プルリクエストのコードレビューを行います。
- Merger: レビューが完了したプルリクエストを
main
ブランチにマージします。
graph TD
subgraph "mainブランチの更新"
A1["git checkout main"]
A2["git pull origin main"]
A1 --> A2
end
subgraph "ブランチの作成"
B1["git checkout -b <branch-name>"]
end
subgraph "コーディングとコミット"
C1["コードの編集や追加"]
C2["git add <changed-files>"]
C3["git commit -m '<commit-message>'"]
C1 --> C2
C2 --> C3
end
subgraph "プルリクエストの作成"
D1["git push origin <branch-name>"]
D2["GitHub上でプルリクエストの作成"]
D1 --> D2
end
A2 --> B1
B1 --> C1
C3 --> D1
-
新しい機能や修正を開始する際のブランチ作成 (Developer):
git checkout main git pull origin main git checkout -b <branch-name>
-
ブランチでの作業 (Developer):
- コミット手順に従って、コミットを作成します。
-
プルリクエストの作成 (Developer):
- PR の説明には、変更内容、変更の背景、テスト方法などを詳細に記載します。
-
コードレビュー (Reviewer):
- 指摘や質問がある場合は、Developer がコードを修正し、再度レビューを依頼します。
-
PR のマージ (Merger):
- 問題ないと判断されたら、
main
ブランチにマージします。
- 問題ないと判断されたら、
-
デプロイ:
main
ブランチにマージされた変更は、本番環境にデプロイする準備が整ったものとみなします。
- バージョンアップは、Merger が
main
ブランチに PR をマージした後、または定期的に行います。 poetry run cz bump
コマンドを用いてバージョンアップを行います。main
ブランチでのみ実施してください。
-
初回コミットの手順: 初回コミットは commitizen を使用しません。 初回コミットに対しては、バージョン用のタグを手動作成する必要があります。
git add . git commit --allow-empty -m "first commit" git tag -a "0.1.0" -m "first version"
上記のバージョンは
pyproject.toml
に合わせてください。 なおバージョンのメジャーバージョンを 1 以上にする場合は、pyproject.toml
のmajor_version_zero = true
の行を削除してください。 -
コミット:
git add <該当ファイル> poetry run pre-commit # この結果により、修正や re-staging が必要なファイルが生じたら修正し git add し直してください。 poetry run cz commit
- そのほかの指針:
- そのほかの開発の指針は
COMMIT_GUIDELINES.md
を参照してください。
- そのほかの開発の指針は