2023-10-02 14:14:19 +00:00
# 🎉 Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! 🎉
2023-09-26 12:48:57 +00:00
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!
2023-10-02 14:14:19 +00:00
2023-10-05 20:01:37 +00:00
All contributors with accepted PRs will receive a cool Holopin! 🤩 (Watch out for a reply in your PR to collect it).
2023-10-02 14:14:19 +00:00
2023-09-26 12:48:57 +00:00
📜 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.
2023-10-05 20:01:37 +00:00
🖥️ Design: Improve the UI/UX or design a new feature.
2023-09-26 12:48:57 +00:00
📝 Guidelines for Pull Requests:
Familiarize yourself with the current contributions and our [Roadmap ](https://github.com/orgs/arc53/projects/2 ).
Deciding to contribute with code? Here are some insights based on the area of your interest:
2023-10-05 20:01:37 +00:00
- Frontend (⚛️
- Most of the code is located in `/frontend` folder. You can also check out our React extension in /extensions/react-widget.
- For design references, here's the [Figma ](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1 ).
- Ensure you adhere to the established guidelines.
2023-09-26 12:48:57 +00:00
2023-10-05 20:01:37 +00:00
- Backend (🐍Python):
- Focus on `/application` or `/scripts` . However, avoid the files ingest_rst.py and ingest_rst_sphinx.py, as they will soon be deprecated.
- Newly added code should come with relevant unit tests (pytest).
- Refer to the `/tests` folder for test suites.
2023-09-26 12:48:57 +00:00
2023-10-05 20:01:37 +00:00
Check out our [Contributing Guidelines ](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md )
2023-09-26 12:48:57 +00:00
2023-10-05 20:01:37 +00:00
Once you have created your PR and our maintainers have merged it, please fill in this [form ](https://airtable.com/appfkqFVjB0RpYCJh/shrXXM98xgRsbjO7s ).
2023-10-02 08:47:39 +00:00
2023-10-05 20:01:37 +00:00
Feel free to join our Discord server. We're here to help newcomers, so don't hesitate to jump in! [Join us here ](https://discord.gg/n5BX8dh8rU ).
2023-09-26 12:48:57 +00:00
2023-10-05 20:01:37 +00:00
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! 🚀
