# Welcome to DocsGPT Contributing guideline

Thank you for choosing this project to contribute to, we are all very grateful!

# We accept different types of contributions

📣 Discussions - where you can start a new topic or answer some questions

🐞 Issues - Is how we track tasks, sometimes its bugs that need fixing, sometimes its new features

🛠️ Pull requests - Is how you can suggest changes to our repository, to work on existing issue or to add new features

📚 Wiki - where we have our documentation


## 🐞 Issues and Pull requests

We value contributions to our issues in form of discussion or suggestion, we recommend that you check out existing issues and our [Roadmap](https://github.com/orgs/arc53/projects/2)

If you want to contribute by writing code there are few things that you should know before doing it:
We have frontend (React, Vite) and Backend (python)

### If you are looking to contribute to Frontend (⚛️React, Vite):
Current frontend is being migrated from /application to /frontend with a new design, so please contribute to the new on. Check out this [Milestone](https://github.com/arc53/DocsGPT/milestone/1) and its issues also [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1)
Please try to follow guidelines


### If you are looking to contribute to Backend (🐍Python):
Check out our issues, and contribute to /application or /scripts (ignore old  ingest_rst.py ingest_rst_sphinx.py files, they will be deprecated soon)
Currently we don't have any tests(which would be useful😉) but before submitting you PR make sure that after you ingested some test data its queryable

### Workflow:
Create a fork, make changes on your forked repository, submit changes in a form of pull request

## Questions / collaboration
Please join our [Discord](https://discord.gg/n5BX8dh8rU) don't hesitate, we are very friendly and welcoming to new contributors.

# Thank you so much for considering to contribute to DocsGPT!🙏