Skip to content

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.

License

Notifications You must be signed in to change notification settings

hari7261/First-OpenSource-Contribution

Folders and files

NameName
Last commit message
Last commit date

Latest commit

Β 

History

16 Commits
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 
Β 

Repository files navigation

πŸš€ Learn Open Source - Real-Time Contribution Display

GitHub Stars GitHub Forks Issues Pull Requests License


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


πŸ“Œ 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

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 ⬇️

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:

git checkout -b feature-name

4. Make Changes and Commit ✍️

Make your changes and commit them with a meaningful message:

git add .
git commit -m "Add: meaningful commit message"

5. Push Changes to GitHub πŸš€

Push your changes to the forked repository:

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.


πŸ“ Project Structure

β”œβ”€β”€ 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

image

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!


πŸ“œ License

This project is licensed under the MIT License – see the 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


⭐ Star this Repository

If you find this project helpful or interesting, please give it a star ⭐ to show your support!


About

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.

Topics

Resources

License

Code of conduct

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published