DocsGPT/HACKTOBERFEST.md

🎉 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.

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 folder. 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.

• 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.

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 (not just simple typo) could earn you a stylish new t-shirt as a token of our appreciation. 🎁 Join us, and let's code together! 🚀

Here is a preview of the shirts: