1.9 KiB
🎉 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! 📜 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 are soon to be deprecated. Newly added code should come with relevant unit tests (pytest). Refer to the /tests folder for test suites.
Check out Contributing Guidelines
Once you have Created your PR and it was merged, please fill in this form
Don't be shy! Hop into our Discord Server. We're a friendly bunch and eager to assist newcomers.
Big thanks for considering contributing to DocsGPT during Hacktoberfest! 🙏 Your effort can earn you a swanky new t-shirt. 🎁 Let's code together! 🚀