Archives/DocsGPT
2
0
Fork 0
mirror of https://github.com/arc53/DocsGPT synced 2024-11-03 23:15:37 +00:00
Code Issues Packages Projects Releases Wiki Activity

Update CONTRIBUTING.md

Browse Source
This commit is contained in:
Adhiraj 2023-10-06 01:40:03 +05:30 committed by GitHub
parent 5a9feb4411
commit 8b6b8f0c53
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
1 changed files with 20 additions and 14 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

34
CONTRIBUTING.md
View File

@ -1,6 +1,6 @@
# Welcome to DocsGPT Contributing guideline # Welcome to DocsGPT Contributing Guidelines
Thank you for choosing this project to contribute to, we are all very grateful! Thank you for choosing this project to contribute to. We are all very grateful!
### [🎉 Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! 🎉](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md) ### [🎉 Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! 🎉](https://github.com/arc53/DocsGPT/blob/main/HACKTOBERFEST.md)
@ -17,30 +17,36 @@ Thank you for choosing this project to contribute to, we are all very grateful!
## 🐞 Issues and Pull requests ## 🐞 Issues and Pull requests
We value contributions to our issues in the form of discussion or suggestion, we recommend that you check out existing issues and our [Roadmap](https://github.com/orgs/arc53/projects/2) We value contributions to our issues in the form of discussion or suggestions. 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 a few things that you should know before doing it: If you want to contribute by writing code, there are a few things that you should know before doing it:
We have frontend (React, Vite) and Backend (python)
We have a frontend in React (Vite) and backend in Python.
### If you are looking to contribute to frontend (⚛️React, Vite):
- The current frontend is being migrated from `/application` to `/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.
- The Figma design can be found [here](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1).
### If you are looking to contribute to Frontend (⚛️React, Vite):
The current frontend is being migrated from /application to /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 also [Figma](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1)
Please try to follow the guidelines. Please try to follow the guidelines.
### If you are looking to contribute to Backend (🐍Python): ### 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) - 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).
* 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. - 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.
* Before submitting your PR make sure that after you ingested some test data it is queryable. - Before submitting your PR, ensure it is queryable after ingesting some test data.
### Testing ### Testing
To run unit tests, from the root of the repository execute:
To run unit tests from the root of the repository, execute:
``` ```
python -m pytest python -m pytest
``` ```
### Workflow: ### Workflow:
Create a fork, make changes on your forked repository, and submit changes in the form of a pull request. Create a fork, make changes on your forked repository, and submit changes as a pull request.
## Questions/collaboration ## Questions/collaboration
Please join our [Discord](https://discord.gg/n5BX8dh8rU) don't hesitate, we are very friendly and welcoming to new contributors. 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 contributing to DocsGPT!🙏 # Thank you so much for considering contributing to DocsGPT!🙏