mirror of
https://github.com/arc53/DocsGPT
synced 2024-11-17 21:26:26 +00:00
36 lines
2.6 KiB
Markdown
36 lines
2.6 KiB
Markdown
# 🎉 Join the Hacktoberfest with DocsGPT and Earn a Free T-shirt! 🎉
|
||
|
||
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](https://github.com/orgs/arc53/projects/2).
|
||
|
||
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 [`/frontend`](https://github.com/arc53/DocsGPT/tree/main/frontend) folder. You can also check out our React extension in [`/extensions/react-widget`](https://github.com/arc53/DocsGPT/tree/main/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.
|
||
|
||
- Backend (🐍Python):
|
||
- Focus on [`/application`](https://github.com/arc53/DocsGPT/tree/main/application) or [`/scripts`](https://github.com/arc53/DocsGPT/tree/main/scripts). However, avoid the files [`ingest_rst.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst.py) and [`ingest_rst_sphinx.py`](https://github.com/arc53/DocsGPT/blob/main/scripts/old/ingest_rst_sphinx.py), as they will soon be deprecated.
|
||
- Newly added code should come with relevant unit tests (pytest).
|
||
- Refer to the [`/tests`](https://github.com/arc53/DocsGPT/tree/main/tests) folder for test suites.
|
||
|
||
Check out our [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md)
|
||
|
||
Once you have created your PR and our maintainers have merged it, please fill in this [form](https://airtable.com/appfkqFVjB0RpYCJh/shrXXM98xgRsbjO7s).
|
||
|
||
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).
|
||
|
||
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! 🚀
|