diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md new file mode 100644 index 00000000..206c5a7f --- /dev/null +++ b/HACKTOBERFEST.md @@ -0,0 +1,38 @@ +# **🎉 Join the Hacktoberfest with DocsGPT and win a Free T-shirt for a meaningful PR! 🎉** + +Welcome, contributors! We're excited to announce that DocsGPT is participating in Hacktoberfest. Get involved by submitting meaningful pull requests. + +All Meaningfull contributors with accepted PRs that where created for issue created by our maintainer team(dartpain, siiddhantt, pabik, ManishMadan2882, tenokami) will receive a cool T-shirt! 🤩. + +Fill in [this form](https://forms.gle/Npaba4n9Epfyx56S8 +) after your PR was merged please + +If you are in doubt don't hesitate to ping us on discord, ping me - Alex (dartpain). + +## 📜 Here's How to Contribute: +```text +🛠️ Code: This is the golden ticket! Make meaningful contributions through PRs. + +🧩 API extension: Build an app utilising DocsGPT API. We prefer submissions that showcase original ideas and turn the API into an AI agent. +They can be a completely separate repos. +For example: +https://github.com/arc53/tg-bot-docsgpt-extenstion or +https://github.com/arc53/DocsGPT-cli + +Non-Code Contributions: + +📚 Wiki: Improve our documentation, create a guide. + +🖥️ 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). +- Before contributing check existing [issues](https://github.com/arc53/DocsGPT/issues) or [create](https://github.com/arc53/DocsGPT/issues/new/choose) an issue and wait to get assigned. +- Once you are finished with your contribution, please fill in this [form](https://forms.gle/Npaba4n9Epfyx56S8). +- Refer to the [Documentation](https://docs.docsgpt.cloud/). +- Feel free to join our [Discord](https://discord.gg/n5BX8dh8rU) 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 (not just simple typos) could earn you a stylish new t-shirt. + +We will publish a t-shirt desing later into the October.