From 5a9feb4411eb70beb90a8841c558c04f4f172f30 Mon Sep 17 00:00:00 2001 From: Adhiraj Date: Fri, 6 Oct 2023 01:31:37 +0530 Subject: [PATCH] Update HACKTOBERFEST.md --- HACKTOBERFEST.md | 28 ++++++++++++++-------------- 1 file changed, 14 insertions(+), 14 deletions(-) diff --git a/HACKTOBERFEST.md b/HACKTOBERFEST.md index 7a0e016e..1a39e561 100644 --- a/HACKTOBERFEST.md +++ b/HACKTOBERFEST.md @@ -2,13 +2,13 @@ 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 PR's will receive a cool holopin! ๐Ÿคฉ (Watchout for a reply in your PR to collect it) +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. + ๐Ÿ–ฅ๏ธ Design: Improve the UI/UX or design a new feature. ๐Ÿ“ Guidelines for Pull Requests: @@ -16,20 +16,20 @@ Familiarize yourself with the current contributions and our [Roadmap](https://gi 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](https://www.figma.com/file/OXLtrl1EAy885to6S69554/DocsGPT?node-id=0%3A1&t=hjWVuxRg9yi5YkJ9-1). - Ensure you adhere to the established guidelines. +- 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](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 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. +- 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 [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) +Check out our [Contributing Guidelines](https://github.com/arc53/DocsGPT/blob/main/CONTRIBUTING.md) -Once you have Created your PR and it was merged, please fill in this [form](https://airtable.com/appfkqFVjB0RpYCJh/shrXXM98xgRsbjO7s) +Once you have created your PR and our maintainers have merged it, please fill in this [form](https://airtable.com/appfkqFVjB0RpYCJh/shrXXM98xgRsbjO7s). -Don't be shy! Hop into our [Discord](https://discord.gg/n5BX8dh8rU) Server. We're a friendly bunch and eager to assist newcomers. +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). -Big thanks for considering contributing to DocsGPT during Hacktoberfest! ๐Ÿ™ Your effort can earn you a swanky new t-shirt. ๐ŸŽ Let's code together! ๐Ÿš€ +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! ๐Ÿš€