https://github.com/hari7261/first-opensource-contribution
An educational repository designed to help beginners learn and experience open source contribution. Participate in real-time collaboration, version control, and GitHub workflows including forking, cloning, branching, committing, and pull requests.
https://github.com/hari7261/first-opensource-contribution
begginer-friendly begginer-project cse excel-engineering-college first-contributions first-opensource-contribution github-pages hari7261 issues open-source open-source-community open-source-project open-sources-code-github pull-request-check pull-request-review pull-requests pullrequest push
Last synced: about 2 months ago
JSON representation
An educational repository designed to help beginners learn and experience open source contribution. Participate in real-time collaboration, version control, and GitHub workflows including forking, cloning, branching, committing, and pull requests.
- Host: GitHub
- URL: https://github.com/hari7261/first-opensource-contribution
- Owner: hari7261
- License: mit
- Created: 2025-01-02T16:17:09.000Z (4 months ago)
- Default Branch: main
- Last Pushed: 2025-02-22T10:21:24.000Z (about 2 months ago)
- Last Synced: 2025-02-22T11:24:29.329Z (about 2 months ago)
- Topics: begginer-friendly, begginer-project, cse, excel-engineering-college, first-contributions, first-opensource-contribution, github-pages, hari7261, issues, open-source, open-source-community, open-source-project, open-sources-code-github, pull-request-check, pull-request-review, pull-requests, pullrequest, push
- Homepage: https://learn-open-source.vercel.app
- Size: 92.8 KB
- Stars: 2
- Watchers: 2
- Forks: 2
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
# 🚀 Learn Open Source - Real-Time Contribution Display
---
Welcome to **Learn Open Source - Real-Time Contribution Display**! This project is designed to provide students with a hands-on experience in open source contribution, version control, and collaborative development.
This event is organized by **Hariom Pandit** and will be hosted at **Excel Engineering College** by the **Third Year CSE, Section A** students.
🌐 **Live Demo:** [Learn Open Source](https://learn-open-source.vercel.app/)
---
## 📌 **Objective**
This repository is part of the Open Source Contribution Program, aimed at:
- Educating students about Open Source Contribution and Version Control using Git & GitHub.
- Providing real-time contribution experience with live profile display.
- Enabling hands-on practice with forking, cloning, branching, pushing, and pull requests.
---
## 📝 **Table of Contents**
- [About the Project](#about-the-project)
- [Getting Started](#getting-started)
- [How to Contribute](#how-to-contribute)
- [Project Structure](#project-structure)
- [Tech Stack](#tech-stack)
- [Contributors](#contributors)
- [License](#license)
- [Feedback](#feedback)
---
## 📖 **About the Project**
This project is built to help students learn about open source contribution while displaying their profiles and contributions in real-time on the website. It demonstrates:
- 🌟 Live display of contributors and their profiles.
- 🔄 Real-time updates with every pull request and merge.
- 🚀 End-to-end open source contribution workflow, including forking, cloning, branching, pushing, pull requests, code reviews, and merging.
---
## 🚀 **Getting Started**
Follow these steps to get started with the repository:
### 1. **Fork the Repository** 🍴
Click on the `Fork` button at the top right corner of this repo to create a copy in your GitHub account.
### 2. **Clone the Forked Repository** ⬇️
```bash
git clone https://github.com/hari7261/First-OpenSource-Contribution.git
cd First-OpenSource-Contribution
```
### 3. **Create a New Branch** 🌿
Create a new branch for the feature you are working on:
```bash
git checkout -b feature-name
```
### 4. **Make Changes and Commit** ✍️
Make your changes and commit them with a meaningful message:
```bash
git add .
git commit -m "Add: meaningful commit message"
```
### 5. **Push Changes to GitHub** 🚀
Push your changes to the forked repository:
```bash
git push origin feature-name
```
### 6. **Create a Pull Request** 🔁
Go to your forked repository on GitHub and click on `Compare & Pull Request`. Provide a clear title and description of your changes.
---
## 🤝 **How to Contribute**
We welcome all contributions, whether you're fixing bugs, adding features, improving documentation, or enhancing the design.
### Contribution Guidelines:
1. **Fork the repository** and create a new branch.
2. **Make your changes** and ensure the code is clean and well-documented.
3. **Commit and push** your changes.
4. **Open a Pull Request** with a detailed description.
5. Wait for the **code review and approval** by the admin.
### Code of Conduct:
Please be respectful and considerate to other contributors. We follow the [Contributor Covenant Code of Conduct](CODE_OF_CONDUCT.md).
---
## 📁 **Project Structure**
```bash
├── public
│ └── index.html
├── src
│ ├── components
│ │ └── ContributorCard.js
│ ├── pages
│ │ └── Home.js
│ └── App.js
├── .gitignore
├── package.json
└── README.md
```
---
## 🛠️ **Tech Stack**
- All programing languages(Choose your any particular programming language where you are comfortable to build projects and make contribute)
---
## 🎨 **UI Preview**
> *Real-Time Display of Contributors with Profile Names*
---
## ✨ **Contributors**
A huge shoutout to all our contributors! 🚀
Hariom Kumar Pandit
Ashwin Sundar
Want to see your face here? [Contribute now!](#how-to-contribute)
---
## 📜 **License**
This project is licensed under the **MIT License** – see the [LICENSE](LICENSE) file for details.
---
## 💬 **Feedback**
We would love to hear your thoughts, suggestions, and feedback! Feel free to open an issue or reach out directly.
---
## 🥳 **Special Thanks**
This event is organized at **Excel Engineering College** by the **Third Year CSE, Section A** students.
A big thank you to all participants, mentors, and volunteers who make this event a success! 🎉
---
## 🔗 **Live Project Link**
[Learn Open Source - Real-Time Contribution Display](https://learn-open-source.vercel.app/)
---
## ⭐ **Star this Repository**
If you find this project helpful or interesting, please give it a star ⭐ to show your support!
---