Merge pull request #112 from SkywardAI/feat/doc

Add dev doc and bump release version

.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

.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
+          make publish

Makefile

@@ -25,6 +25,10 @@ build:
 lock:
 	@poetry lock
 
+.PHONY: shell
+shell:
+	@poetry shell
+
 .PHONY: install
 install:
 	@poetry install -vvv

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
 

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
+```
+