update README

README.md

@@ -1,29 +1,176 @@
 # Almondo-PoC-Template
 
-PoC 用のテンプレートリポジトリ
+PoC 用のテンプレートリポジトリです。
+本READMEは以下の構成で作成されています。
+1. セットアップ
+2. ディレクトリ構造
 
 ## セットアップ
-
-### 前提
+------------------
+#### 前提
 
 - docker のインストール
 
-### セットアップ手順
-
-1. .env.dev を作成する
+#### セットアップ手順
+1. git cloneを行う
+* 本リポジトリの右上にあるCodeボタンからリポジトリのurlを取得
+```bash
+git clone [repositry url]
+```
+2. デフォルトブランチの確認
+* develop ブランチになっているかどうか
+```bash
+git branch 
+```
+* 以下のようにdevelopに印がついていたら問題ない
+```bash
+* develop
+  main
+```
+3. .env.dev を作成する
+* env.dev.templeteがあるので,それを複製して作成する
 
+4. コンテナを起動する
+* 初回のみbuildが実行される
 ```bash
+docker-compose run development bash
+```
+
+5. poetry でパッケージをインストールする
+* 以下のコードにてdocker container上に必要なパッケージがインストールされる。
 
+```
+poetry install
+```
+#### dockerの基本操作
+起動中のコンテナの確認
+```
+docker ps
+```
+起動中のコンテナに入る
+```
+docker exec -it [container id] bash
+```
+起動中のコンテナを落とす
+```
+docker-compose down
+```
+#### パッケージの追加削除
+パッケージの追加
+* パッケージ名にバージョンを指定することで,バージョンのアップグレード及びダウングレードができます
+```
+poetry add [パッケージ名]
+```
+パッケージの削除
+```
+poetry remove [パッケージ名]
+```
+
+#### VScode上での作業
+
+
+
+## 開発の手順
+Issue driven開発手法での開発をしていただきます。
+詳細は以下ページに記載してあります
+- Issue driven運用のドキュメント
+https://www.notion.so/Issue-driven-5378336f66c243f7933b52a15ce15ee7?p=9b275fa3a5e841eea11133f900a80499&pm=s
+
+Issue　driven開発の大まかな手順は以下の8つです．
+
+1. **Issueを作成**
+  - 本ページの画面上部にあるIssuesから作成してください
+2. **ブランチを切る**
+   - brach名は以下の2つの規則に従ってください
+    - feature/~~~~~
+        - 新規機能の追加などの際に使用するブランチ
+    - fix/~~~~~
+        - 様々な改修や、バグ修正を行うブランチ
+3. **2で切ったブランチで作業**
+```
+   git fetch origin
+git checkout branch名
 ```
 
-2. コンテナを起動する
+1. **作業内容をpush**
+   変更内容をaddする前に，必ず以下のコマンドを実行し，最新のmainブランチの内容を反映させてください．
 
+※最新のmainの内容が反映されていない場合，プルリクエストをマージする際にコンフリクトが発生する可能性があります．
+基本的なpushまでの流れ
+
+addをします
 ```bash
-docker-compose run development bash
+git add file名
+```
+commitをします
+
+```bash
+git commit -m "commit message"
 ```
 
-3. poetry でパッケージをインストールする
+最後に以下のコマンドでpushをします．
 
 ```bash
-poetry install
+git push
+```
+1. **プルリクエストの作成**
+   本画面の上部に「Compare & pull request」と表示されるのでそれをクリックしてプルリクエストを作成してください
+2. **プルリクエストをレビュー(レビュワーが担当)**
+   作成されたPRからPjMがレビューを行います
+3. **mainブランチにマージをして，作業ブランチを削除する**
+　 レビュー内容を確認し問題がなければ,developブランチにマージをして作業ブランチを削除してください
+
+
+## ディレクトリ構造
+------------------
+主なディレクトリ構造
+```
+root/
+├── .github/
+│   └── workflows/        # CI/CDワークフロー定義
+│       └── pysen-python-app.yaml         # データモデル
+├── data/                 # プロジェクトドキュメント
+│   ├── models/           # データモデル
+│   ├── preprocessed/         # ビジネスロジック
+│   └── raw/            # ユーティリティ関数
+│   └── results/  
+├── work/                  # ソースコード        
+│   ├── example/           # データモデル
+│   ├── experiments/         # ビジネスロジック
+│   └── src/            # ユーティリティ関数
+│   └── tests/            # ユーティリティ関数
+├── .env.dev.template     # 開発環境変数テンプレート
+├── .gitignore            # Gitが無視するファイル設定
+├── Dockerfile            # Dockerイメージ定義
+├── README.md             # プロジェクト説明（本ファイル）
+├── docker-compose.yml    # Docker Compose設定
+├── entrypoint.sh    # Docker Compose設定
+├── poetry.lock        # Poetryプロジェクト設定
+├── pyproject.toml        # Poetryプロジェクト設定
+└── LICENSE               # ライセンス情報
 ```
+### work
+#### exmaple
+- 先方にコードの実行例を見せるときやデモ等の共有の際に必要な綺麗なコードをまとめる場所
+- spacesのデモ等
+#### experiments
+- 実行コード置き場
+- 基本的な実験的なコードはここに置く
+- 種々の実験はここで行う
+- promptのようなプロジェクトに依存するものはこちら
+#### src
+- プロジェクトごとに使いまわせるようなやつプロジェクトに依存しない基本クラス
+- クラス化されたsrc code 置き場
+- 各コードに共通する基本クラスはここ
+#### tests
+* 単体テストを置くフォルダ
+### dataフォルダ
+githubには上がらないようになっていますが以下の構成で分けてください
+#### model
+（モデル保存場所、tuningしたpthファイルなど）
+#### preprocessed
+（前処理済みデータ,csvやtextファイルなど）
+#### raw
+生データ保管場所（先方から提供されたexcelファイルなど）
+#### results
+（結果保存場所、各タスクごとの出力結果保存）