From 5c7ffb16ad9e8bd4bc69c9677ae711979a58558a Mon Sep 17 00:00:00 2001
From: Aisuko <urakiny@gmail.com>
Date: Mon, 1 Jul 2024 05:44:31 +0000
Subject: [PATCH] Add dev doc and bump release version

Signed-off-by: Aisuko <urakiny@gmail.com>
---
 .github/workflows/release-drafter.yml |  2 +-
 .github/workflows/release.yml         |  2 +-
 Makefile                              |  4 +++
 README.md                             |  2 +-
 docs/Development.md                   | 35 +++++++++++++++++++++++++++
 5 files changed, 42 insertions(+), 3 deletions(-)
 create mode 100644 docs/Development.md

diff --git a/.github/workflows/release-drafter.yml b/.github/workflows/release-drafter.yml
index e767f22..941a47b 100644
--- a/.github/workflows/release-drafter.yml
+++ b/.github/workflows/release-drafter.yml
@@ -26,7 +26,7 @@ jobs:
     runs-on: ubuntu-latest
     steps:
       # Drafts your next Release notes as Pull Requests are merged into "master"
-      - uses: release-drafter/release-drafter@v5
+      - uses: release-drafter/release-drafter@v6
         # (Optional) specify config name to use, relative to .github/. Default: release-drafter.yml
         with:
           config-name: release-drafter.yml
diff --git a/.github/workflows/release.yml b/.github/workflows/release.yml
index dca3897..43112c9 100644
--- a/.github/workflows/release.yml
+++ b/.github/workflows/release.yml
@@ -33,4 +33,4 @@ jobs:
         run: |
           poetry config repositories.source ${{ secrets.PYPI_HOMEPAGE }}
           poetry config pypi-token.pypi ${{ secrets.PYPI_TOKEN }}
-          poetry publish --build
\ No newline at end of file
+          make publish
\ No newline at end of file
diff --git a/Makefile b/Makefile
index 6368bbf..dcddf25 100644
--- a/Makefile
+++ b/Makefile
@@ -25,6 +25,10 @@ build:
 lock:
 	@poetry lock
 
+.PHONY: shell
+shell:
+	@poetry shell
+
 .PHONY: install
 install:
 	@poetry install -vvv
diff --git a/README.md b/README.md
index f85e145..0f24b59 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ See examples in the [examples](./examples) directory.
 
 # Development
 
-Please kindly check the .devcontainer directory for the development environment setup.
+See [Development Guide](./docs/Development.md).
 
 # Acknowledgement
 
diff --git a/docs/Development.md b/docs/Development.md
new file mode 100644
index 0000000..b6198b7
--- /dev/null
+++ b/docs/Development.md
@@ -0,0 +1,35 @@
+# Development
+
+We recommend to use VSCode and [Devcontainer](../.devcontainer/devcontainer.json) for development. We can keep the development environment consistent and isolated from the host machine. And also same as the CI/CD environment.
+
+## Setup
+
+After open form the Devcontainer, run the following commands to setup the development environment.
+
+```bash
+make poetry
+```
+
+```bash
+make build
+```
+
+```bash
+# Execution pyhton 3.11 env
+make shell
+```
+
+After you finish coding, run the follow commands to check the code quality and test.
+
+```bash
+make lint
+```
+
+```bash
+make install
+```
+
+```bash
+make test
+```
+