From f5510ef1b5f571889bb629ce3575cb408772c061 Mon Sep 17 00:00:00 2001 From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com> Date: Fri, 13 Oct 2023 18:32:56 +0530 Subject: [PATCH 1/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 7 +++++-- 1 file changed, 5 insertions(+), 2 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index e69228ce..f5aba79d 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,10 +21,13 @@ We value contributions in the form of discussions or suggestions. We recommend t Before creating issues, please check out how the latest version of our app looks and works by launching it via [Quickstart](https://github.com/arc53/DocsGPT#quickstart) the version on our live demo is slightly modified with login. Your issues should relate to the version that you can launch via [Quickstart](https://github.com/arc53/DocsGPT#quickstart). -If you're interested in contributing code, here are some important things to know: +## πŸ‘¨β€πŸ’» If you're interested in contributing code, here are some important things to know: -We have a frontend built with React (Vite) and a backend in Python. +Tech Stack Overview: +- 🌐 Frontend: Built with React (Vite) βš›οΈ, + +- πŸ–₯ Backend: Developed in Python 🐍 ### If you are looking to contribute to frontend (βš›οΈReact, Vite): From 9e6aecd7078004ac6547e8ba1cfe78fd8a60a1a4 Mon Sep 17 00:00:00 2001 From: Digvijay Shelar <82649533+shelar1423@users.noreply.github.com> Date: Fri, 13 Oct 2023 18:35:13 +0530 Subject: [PATCH 2/2] Update CONTRIBUTING.md --- CONTRIBUTING.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index f5aba79d..827c9086 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,7 +21,7 @@ We value contributions in the form of discussions or suggestions. We recommend t Before creating issues, please check out how the latest version of our app looks and works by launching it via [Quickstart](https://github.com/arc53/DocsGPT#quickstart) the version on our live demo is slightly modified with login. Your issues should relate to the version that you can launch via [Quickstart](https://github.com/arc53/DocsGPT#quickstart). -## πŸ‘¨β€πŸ’» If you're interested in contributing code, here are some important things to know: +### πŸ‘¨β€πŸ’» If you're interested in contributing code, here are some important things to know: Tech Stack Overview: @@ -29,7 +29,7 @@ Tech Stack Overview: - πŸ–₯ Backend: Developed in Python 🐍 -### If you are looking to contribute to frontend (βš›οΈReact, Vite): +### 🌐 If you are looking to contribute to frontend (βš›οΈReact, Vite): - The current frontend is being migrated from [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) to [`/frontend`](https://github.com/arc53/DocsGPT/tree/main/frontend) with a new design, so please contribute to the new one. - Check out this [milestone](https://github.com/arc53/DocsGPT/milestone/1) and its issues. @@ -37,7 +37,7 @@ Tech Stack Overview: Please try to follow the guidelines. -### If you are looking to contribute to Backend (🐍 Python): +### πŸ–₯ If you are looking to contribute to Backend (🐍 Python): - Review our issues and contribute to [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) or [`/scripts`](https://github.com/arc53/DocsGPT/tree/main/scripts) (please disregard old [`ingest_rst.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) [`ingest_rst_sphinx.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py) files; they will be deprecated soon). - All new code should be covered with unit tests ([pytest](https://github.com/pytest-dev/pytest)). Please find tests under [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder.