Skip to content

Add Contributing.md #59

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 3 commits into from
Sep 2, 2025
Merged

Add Contributing.md #59

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
77cfea7
Add CONTRIBUTING.md
DivyaJain09 Sep 1, 2025
85b2ec2
Update CONTRIBUTING.md
DivyaJain-DataAnalyst Sep 1, 2025
d7a017d
Update CONTRIBUTING.md
DivyaJain-DataAnalyst Sep 1, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
138 changes: 138 additions & 0 deletions CONTRIBUTING.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,138 @@
<h1 align="center">✨ Contributors Guide ✨</h1>

<h3 align="center">Welcome to the My-first-Neo-project project! 😍<br>
We appreciate your interest in contributing.😊<br> </h3>

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 [`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.

![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)

<h2 align="center">Need More Help? 🤔</h1>

<p align="center"> You can refer to the following articles on basics of Git and Github and also contact the Project Mentors, in case you are stuck: <br>
<a href="https://help.github.com/en/desktop/contributing-to-projects/creating-an-issue-or-pull-request">How to create a Issue</a> <br>
<a href="https://help.github.com/en/github/getting-started-with-github/fork-a-repo">Forking a Repo</a> <br>
<a href="https://docs.github.com/en/get-started/quickstart/fork-a-repo#cloning-your-forked-repository">Cloning a Repo</a> <br>
<a href="https://opensource.com/article/19/7/create-pull-request-github">How to create a Pull Request</a> <br>
<a href="https://docs.github.com/get-started">Getting started with Git and GitHub</a> <br>
</p>

<h3 align="center">Show some &nbsp;❤️&nbsp; by &nbsp;🌟&nbsp; this repository!</h3>

![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!!

<h3 align="center">
Thank you for contributing to My-first-Neo-project🌟
<br>
We can't wait to see what you build! 🍽️✨
</h3>
Loading