Merge pull request #177 from kyaukyuai/feat/pyright

Add contribution guidelines and pyright setup.- Add contribution guid…
kyaukyuai · Mar 16, 2024 · 108205c · 108205c
2 parents 5e94a7d + 25d9993
commit 108205c
Show file tree

Hide file tree

Showing 4 changed files with 116 additions and 3 deletions.
diff --git a/README.md b/README.md
@@ -21,6 +21,7 @@ This is a research-project, and its primary value is to explore the possibility
 - [🕴 Current Situation](#-current-situation)
 - [🔎 Examples](#-examples)
   - [⏱️ Pomodoro Timer](#️-pomodoro-timer)
+- [🍻 Contribution](#-contribution)
 
 ## 🏛 Concept
 
@@ -156,3 +157,50 @@ We would like to test other languages and libraries as well and welcome contribu
 - 💻️ [GitHub](https://github.com/gpt-all-star/pomodoro)
 
 ![Export-1707059574807](https://github.com/kyaukyuai/gpt-all-star/assets/1140707/c194dced-d179-4d1e-8e5d-f89dbafa00ee)
+
+## 🍻 Contribution
+
+GPT ALL STAR is open-source and we welcome contributions. If you're looking to contribute, please:
+
+- Fork the repository.
+- Create a new branch for your feature.
+- Add your feature or improvement.
+- Send a pull request.
+- We appreciate your input!
+
+**Installing Dependencies**
+
+```bash
+poetry lock
+poetry install
+```
+
+**Virtual Env**
+
+```bash
+poetry shell
+```
+
+**Pre-commit hooks**
+
+```bash
+pre-commit install
+```
+
+**Running static type checks**
+
+```bash
+poetry run pyright
+```
+
+**Packaging**
+
+```bash
+poetry build
+```
+
+**Installing Locally**
+
+```bash
+pip install dist/*.tar.gz
+```
diff --git a/docs/index.md b/docs/index.md
@@ -98,3 +98,50 @@ We would like to test other languages and libraries as well and welcome contribu
 - 💻️ [GitHub](https://github.com/gpt-all-star/pomodoro)
 
 ![Export-1707059574807](https://github.com/kyaukyuai/gpt-all-star/assets/1140707/c194dced-d179-4d1e-8e5d-f89dbafa00ee)
+
+## 🍻 Contribution
+
+GPT ALL STAR is open-source and we welcome contributions. If you're looking to contribute, please:
+
+- Fork the repository.
+- Create a new branch for your feature.
+- Add your feature or improvement.
+- Send a pull request.
+- We appreciate your input!
+
+**Installing Dependencies**
+
+```bash
+poetry lock
+poetry install
+```
+
+**Virtual Env**
+
+```bash
+poetry shell
+```
+
+**Pre-commit hooks**
+
+```bash
+pre-commit install
+```
+
+**Running static type checks**
+
+```bash
+poetry run pyright
+```
+
+**Packaging**
+
+```bash
+poetry build
+```
+
+**Installing Locally**
+
+```bash
+pip install dist/*.tar.gz
+```
diff --git a/poetry.lock b/poetry.lock
diff --git a/pyproject.toml b/pyproject.toml
@@ -44,6 +44,7 @@ pre-commit = "^3.6.1"
 mkdocs = "^1.5.3"
 mkdocs-material = "^9.5.11"
 python-semantic-release = "^9.1.1"
+pyright = "^1.1.354"
 
 [tool.pyright]
 # https://github.com/microsoft/pyright/blob/main/docs/configuration.md