From 5ada5bf1a0650008414e53813712f984c1780162 Mon Sep 17 00:00:00 2001 From: Alex Date: Mon, 23 Sep 2024 17:30:58 +0100 Subject: [PATCH] Create HACKTOBERFEST.md --- HACKTOBERFEST.md | 36 ++++++++++++++++++++++++++++++++++++ 1 file changed, 36 insertions(+) create mode 100644 HACKTOBERFEST.md diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md new file mode 100644 index 00000000..2cf73ea1 --- /dev/null +++ b/HACKTOBERFEST.md @@ -0,0 +1,36 @@ +# **🎉 Join the Hacktoberfest with DocsGPT and win a Free T-shirt and other prizes! 🎉** + +Welcome, contributors! We're excited to announce that DocsGPT is participating in Hacktoberfest. Get involved by submitting meaningful pull requests. + +All contributors with accepted PRs will receive a cool Holopin! 🤩 (Watch out for a reply in your PR to collect it). + +### 🏆 Top 50 contributors will recieve a special T-shirt + +### 🏆 LLM Document analysis by LexEU competition: +A separate competition is available for those sumbit best new retrieval method that will analyze a Document using EU laws. +You will find more information about it on 1st of October. + +## 📜 Here's How to Contribute: +```text +🛠️ Code: This is the golden ticket! Make meaningful contributions through PRs. + +🧩 API extention: Build an app utilising DocsGPT API. We prefer submissions that showcase original ideas and turn the API into an AI agent. + +Non-Code Contributions: + +📚 Wiki: Improve our documentation, Create a guide or change existing documentation. + +🖥️ Design: Improve the UI/UX or design a new feature. + +📝 Blogging or Content Creation: Write articles or create videos to showcase DocsGPT or highlight your contributions! +``` + +### 📝 Guidelines for Pull Requests: +- Familiarize yourself with the current contributions and our [Roadmap](https://github.com/orgs/arc53/projects/2). +- Before contributing we highly advise that you 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://airtable.com/appikMaJwdHhC1SDP/pagoblCJ9W29wf6Hf/form). +- 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 typo) could earn you a stylish new t-shirt and other prizes as a token of our appreciation. 🎁 Join us, and let's code together! 🚀 +