Thank you for choosing to contribute to DocsGPT! We are all very grateful!
📣 Discussions - Engage in conversations, start new topics, or help answer questions.
🐞 Issues - This is where we keep track of tasks. It could be bugs,fixes or suggestions for new features.
🛠️ Pull requests - Suggest changes to our repository, either by working on existing issues or adding new features.
📚 Wiki - This is where our documentation resides.
We value contributions in the form of discussions or suggestions. We recommend taking a look at existing issues and our roadmap.
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.
- 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.
- Review our issues and contribute to
/applicationor/scripts(please disregard 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 Pull Request, ensure it can be queried after ingesting some test data.
To run unit tests from the root of the repository, execute:
python -m pytest
Fork the repository, make your changes on your forked version, and then submit those changes as a pull request.
Feel free to join our Discord. We're very friendly and welcoming to new contributors, so don't hesitate to reach out.