diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 28672a7e..9af215d8 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -21,12 +21,15 @@ 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) βš›οΈ, -### If you are looking to contribute to frontend (βš›οΈReact, Vite): +- πŸ–₯ Backend: Developed in Python 🐍 + +### 🌐 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. @@ -34,7 +37,7 @@ We have a frontend built with React (Vite) and a backend in Python. 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.