Merge pull request #36 from code-yeongyu/feature/update-readme-description

Update readme about Development Environments overview

Author: code-yeongyu

.vscode/settings.json

@@ -1,8 +1,4 @@
 {
-    "python.envFile": "${workspaceFolder}/.env",
-    "python.formatting.yapfPath": "${workspaceFolder}/.venv/bin/yapf",
-    "python.languageServer": "Pylance",
-    "python.formatting.provider": "yapf",
     "[python]": {
         "editor.insertSpaces": true,
         "editor.tabSize": 4,
@@ -13,10 +9,14 @@
             "source.organizeImports": true
         }
     },
-    "isort.path": [
-        "${workspaceFolder}/.venv/bin/isort"
-    ],
+    "python.envFile": "${workspaceFolder}/.env",
+    "python.languageServer": "Pylance",
+    "python.formatting.provider": "yapf",
+    "python.formatting.yapfPath": "${workspaceFolder}/.venv/bin/yapf",
+    "python.linting.enabled": true,
+    "python.linting.pylintEnabled": true,
     "python.linting.pylintPath": "${workspaceFolder}/.venv/bin/pylint",
+    "python.linting.mypyEnabled": true,
     "python.linting.mypyArgs": [
         "--strict",
         "--follow-imports=silent",
@@ -26,10 +26,13 @@
         "--namespace-packages",
         "--no-implicit-reexport"
     ],
+    "isort.path": [
+        "${workspaceFolder}/.venv/bin/isort"
+    ],
+    "python.testing.pytestEnabled": true,
     "python.testing.pytestArgs": [
         "."
     ],
-    "python.testing.pytestEnabled": true,
     "emeraldwalk.runonsave": {
         "commands": [
             {
@@ -38,9 +41,6 @@
             }
         ]
     },
-    "python.linting.enabled": true,
-    "python.linting.pylintEnabled": true,
-    "python.linting.mypyEnabled": true,
     "[toml]": {
         "editor.defaultFormatter": "tamasfe.even-better-toml"
     }

README.md

@@ -29,13 +29,19 @@ poetry add twitter-video-tools
 - poetry
 - code editor (vscode recommended)
 
-### Quick Info of setups
-
-- strict type checking using mypy
-- amazing linters & formatters (`yapf`, `pylint`, `isort`)
-  - `unify` for forcing single-quote
-- unit test using `pytest`
-- vscode launch & formatting setups
+### Overview of Development Environments
+
+- Local
+  - vscode ready (launching, debugging, formatting)
+  - strict type checking using [mypy](https://github.com/python/mypy) & [pyright](https://github.com/microsoft/pyright)
+  - amazing linters & formatters ([`yapf`](https://github.com/google/yapf), [`pylint`](https://github.com/PyCQA/pylint), [`isort`](https://github.com/PyCQA/isort))
+    - `unify` for forcing single-quote
+  - unit test using [`pytest`](https://github.com/myint/unify)
+
+- GitHub Actions
+  - [All PRs are statically analyzed & checked by `yapf`, `pylint`, `pyright`, `mypy`](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/check_code.yaml)
+  - [All PRs are tested with `pytest`](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/test.yaml)
+  - [Can be released with Github Action when creating GitHub Releases](https://github.com/code-yeongyu/TwitterVideoTools/actions/workflows/release.yaml)
 
 ### All-in-one