2.8 KiB
Welcome to DocsGPT Contributing Guidelines
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! 🎉
We accept different types of contributions
📣 Discussions - where you can start a new topic or answer some questions
🐞 Issues - This is how we track tasks, sometimes it is bugs that need fixing, and sometimes it is new features
🛠️ Pull requests - This is how you can suggest changes to our repository, to work on existing issues or add new features
📚 Wiki - where we have our documentation
🐞 Issues and Pull requests
We value contributions to our issues in the form of discussion or suggestions. We recommend that you check out existing issues and our roadmap.
If you want to contribute by writing code, there are a few things that you should know before doing it:
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
/applicationto/frontendwith a new design, so please contribute to the new one. - Check out this milestone and its issues.
- The Figma design can be found here.
Please try to follow the guidelines.
If you are looking to contribute to Backend (🐍 Python):
- Check out our issues and contribute to
/applicationor/scripts(ignore oldingest_rst.pyingest_rst_sphinx.pyfiles; they will be deprecated soon). - All new code should be covered with unit tests (pytest). Please find tests under
/testsfolder. - Before submitting your PR, ensure it is queryable after ingesting some test data.
Testing
To run unit tests from the root of the repository, execute:
python -m pytest
Workflow:
Create a fork, make changes on your forked repository, and submit changes as a pull request.
Questions/collaboration
Please join our Discord. Don't hesitate; we are very friendly and welcoming to new contributors.