Welcome, contributors! We're excited to announce that DocsGPT is participating in Hacktoberfest. Get involved by submitting a meaningful pull request, and earn a free shirt in return!
All contributors with accepted PRs will receive a cool Holopin! 🤩 (Watch out for a reply in your PR to collect it).
📜 Here's How to Contribute:
🛠️ Code: This is the golden ticket! Make meaningful contributions through PRs.
📚 Wiki: Improve our documentation, Create a guide or change existing documentation.
🖥️ Design: Improve the UI/UX or design a new feature.
📝 Guidelines for Pull Requests:
Familiarize yourself with the current contributions and our Roadmap.
Deciding to contribute with code? Here are some insights based on the area of your interest:
-
Frontend (⚛️React, Vite):
- Most of the code is located in
/frontendfolder. You can also check out our React extension in/extensions/react-widget. - For design references, here's the Figma.
- Ensure you adhere to the established guidelines.
- Most of the code is located in
-
Backend (🐍Python):
- Focus on
/applicationor/scripts. However, avoid the filesingest_rst.pyandingest_rst_sphinx.py, as they will soon be deprecated. - Newly added code should come with relevant unit tests (pytest).
- Refer to the
/testsfolder for test suites.
- Focus on
Check out our Contributing Guidelines
Once you have created your PR and our maintainers have merged it, please fill in this form.
Feel free to join our Discord server. We're here to help newcomers, so don't hesitate to jump in! Join us here.
Thank you very much for considering contributing to DocsGPT during Hacktoberfest! 🙏 Your contributions could earn you a stylish new t-shirt as a token of our appreciation. 🎁 Join us, and let's code together! 🚀