diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 76e60f65b..93397a3c6 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -19,10 +19,13 @@ Thank you for choosing to contribute to DocsGPT! We are all very grateful! We value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our [roadmap](https://github.com/orgs/arc53/projects/2). +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. + 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. + ### 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.