From 77cfea7ab8440e7a8e98366adad4563a55f42455 Mon Sep 17 00:00:00 2001 From: DivyaJain09 Date: Mon, 1 Sep 2025 10:07:22 +0530 Subject: [PATCH 1/3] Add CONTRIBUTING.md --- CONTRIBUTING.md | 138 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 138 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..5090ad8 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,138 @@ +

✨ Contributors Guide ✨

+ +

Welcome to the My-first-Neo-project project! 😍
+We appreciate your interest in contributing.😊

+ +First off, thank you for considering contributing to **My-first-Neo-project!** We're excited to have you join our community. Every contribution, no matter how small, helps us build the best academic resource platform for students. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +This guide will walk you through the entire contribution process, from setting up your local environment to submitting a polished pull request. + +> **New to Open Source?** No problem! This guide is designed to be beginner-friendly. If you get stuck, don't hesitate to open an issue or ask for help. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 📋 Table of Contents + +1. [Code of Conduct](#-code-of-conduct) +2. [License](#-license) +3. [Ways to Contribute](#-ways-to-contribute) +4. [Points & Difficulty Levels](#-points--difficulty-levels) +5. [Contribution Guidelines](#-contribution-guidelines) +6. [PR review Process](#-pr-review-process) +7. [How To Contribute](#-how-to-contribute) +8. [Need More Help](#-need-more-help) +9. [Attribution](#-attribution) +10. [Thank you for your contribution](#thank-you-for-your-contribution) + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 📜 Code of Conduct + +We expect all contributors to follow our `Coming Soon` . + +By participating in this project, you agree to maintain a **respectful and inclusive environment** for everyone. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 📜 License + +By contributing to this project, you agree that your contributions will be licensed under the [MIT License](https://github.com/Jai-76/My-first-Neo-project/blob/main/License). + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 🤝 Ways to Contribute +You can contribute in several ways: +- **🐞 Report Bugs:** Submit issues for reproducible bugs. +- **💡 Suggest Features:** Propose new ideas or improvements. +- **📖 Improve Documentation:** Enhance clarity, grammar, or structure. +- **⚡ Add Code:** Fix bugs, build new features, or optimize existing ones. +- **🧪 Test:** Help us find issues by testing code in different environments. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 🎯 Points & Difficulty Levels + +*Your contributions earn points that count toward GSSoC'25 and your My-first-Neo-project Leaderboard status!* + +| Difficulty | Points | +| :--------- | :----- | +| Level 1 | 3 | +| Level 2 | 7 | +| Level 3 | 10 | + +> **Note:** The scoring system applies only to GSSOC contributors. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 💡 Contribution Guidelines + +* **Code Style**: Use clean, readable code with meaningful names. +* **UI Consistency**: Follow the modern UI style with animated gradients. +* **Responsive Design**: Ensure changes work on both desktop and mobile. +* **Commit Messages**: Use descriptive commit messages. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## ✅ PR Review Process + +We aim to keep things smooth and transparent: + +* Once your PR is submitted, a maintainer will review it. +* You may be asked to: + * Fix styling issues. + * Add missing documentation/tests. + * Break large PRs into smaller pieces. +* After approval: + * Your PR will be merged with a squash merge to keep history clean. + * You’ll receive feedback, even if the PR isn’t merged immediately. +* ⌛ Reviews may take **24–72 hours** depending on activity. Thanks for your patience! + + > For Any Query, Send a DM on LinkedIn [Shahid](https://www.linkedin.com/in/jaideep-shekhawat/). + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## How To Contribute + +- Drop a Star ⭐ in this repo +- Take a look at the existing [Issues](https://github.com/Jai-76/My-first-Neo-project/issues). +- Fork the Repo & create a branch for any issue that you are working on and commit your work. +- At first raise an issue in which you want to work +- Then after assigning only then work on that issue & make a PR +- Create a [**Pull Request**](https://github.com/Jai-76/My-first-Neo-project/pulls), which will be promptly reviewed and given suggestions for improvements by the community. +- **REMINDER: Don't raise more than 2 `Issue` at a time** +- **IMPORTANT: Don't make any type of `Pull Request` until & unless you get assigned to an `Issue`** +- Add screenshots or screen captures to your `Pull Request` to help us understand the effects of the changes that are included in your commits. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +

Need More Help? 🤔

+ +

You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck:
+ How to create a Issue
+ Forking a Repo
+ Cloning a Repo
+ How to create a Pull Request
+ Getting started with Git and GitHub
+

+ +

Show some  ❤️  by  🌟  this repository!

+ +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 🏅Attribution + +This **CONTRIBUTING.md** was prepared with **❤️** by **Divya Jain** for **My-first-Neo-project** as part of the **GSSoC'25 program.** + +The structure and recommendations follow **GitHub Open Source Guides** and best practices used in leading open-source repositories. + +![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) + +## 👍Thank you for your contribution!! + +

+Thank you for contributing to My-first-Neo-project🌟 +
+We can't wait to see what you build! 🍽️✨ +

\ No newline at end of file From 85b2ec2b9e30c19d8c5eb2d3ff914489edb9722f Mon Sep 17 00:00:00 2001 From: Divya Jain <147162320+DivyaJain-DataAnalyst@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:12:36 +0530 Subject: [PATCH 2/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 5090ad8..d41d6aa 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ This guide will walk you through the entire contribution process, from setting u ## 📜 Code of Conduct -We expect all contributors to follow our `Coming Soon` . +We expect all contributors to follow our [`Code of Conduct`](https://github.com/Jai-76/My-first-Neo-project/blob/main/CODE_OF_CONDUCT.md . By participating in this project, you agree to maintain a **respectful and inclusive environment** for everyone. @@ -38,7 +38,7 @@ By participating in this project, you agree to maintain a **respectful and inclu ## 📜 License -By contributing to this project, you agree that your contributions will be licensed under the [MIT License](https://github.com/Jai-76/My-first-Neo-project/blob/main/License). +By contributing to this project, you agree that your contributions will be licensed under the [`MIT License`](https://github.com/Jai-76/My-first-Neo-project/blob/main/License). ![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) @@ -121,7 +121,7 @@ We aim to keep things smooth and transparent: ![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) -## 🏅Attribution +## 🏅 Attribution This **CONTRIBUTING.md** was prepared with **❤️** by **Divya Jain** for **My-first-Neo-project** as part of the **GSSoC'25 program.** @@ -129,10 +129,10 @@ The structure and recommendations follow **GitHub Open Source Guides** and best ![Line](https://user-images.githubusercontent.com/85225156/171937799-8fc9e255-9889-4642-9c92-6df85fb86e82.gif) -## 👍Thank you for your contribution!! +## 👍 Thank you for your contribution!! -

+

Thank you for contributing to My-first-Neo-project🌟
We can't wait to see what you build! 🍽️✨ -

\ No newline at end of file + From d7a017d3970e25fe7a028bed3b3e00b1d2adc4a4 Mon Sep 17 00:00:00 2001 From: Divya Jain <147162320+DivyaJain-DataAnalyst@users.noreply.github.com> Date: Mon, 1 Sep 2025 10:13:56 +0530 Subject: [PATCH 3/3] Update CONTRIBUTING.md --- CONTRIBUTING.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index d41d6aa..23ac055 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -30,7 +30,7 @@ This guide will walk you through the entire contribution process, from setting u ## 📜 Code of Conduct -We expect all contributors to follow our [`Code of Conduct`](https://github.com/Jai-76/My-first-Neo-project/blob/main/CODE_OF_CONDUCT.md . +We expect all contributors to follow our [`Code of Conduct`](https://github.com/Jai-76/My-first-Neo-project/blob/main/CODE_OF_CONDUCT.md). By participating in this project, you agree to maintain a **respectful and inclusive environment** for everyone.