Skip to content

Latest commit

 

History

History
125 lines (102 loc) · 4.35 KB

CONTRIBUTING.md

File metadata and controls

125 lines (102 loc) · 4.35 KB
Raw

Stars Contributors Repo Size Issues Pull Requests Forks

🚀 How to Contribute to Innovate-with-Open-Source

Thank you for your interest in contributing! Follow the steps below to make your contribution for Hacktoberfest. 🎉

Tech Stack 🛠️

  • Next.js
  • Vercel
  • Git
  • GitHub

📑 Steps to Contribute

What should I contribute?

Steps to Contribute

  • Open the lib/data.js file
  • You will see a snippet of code below.
  • Just add that code with YOUR NAME and YOUR GITHUB PROFILE link to the array to make a simple contribution.
//Male:- https://avatar.iran.liara.run/public/job/operator/male
//Female:- https://avatar.iran.liara.run/public/job/operator/female
{
  name: "Your Name",
  role: "Your Role (e.g., Contributor)",
  github: "https://github.com/your-github-username",
  image: "https://avatar.iran.liara.run/public/job/operator/male" // or your image URL
}

And that's all ! 🚀

How to Contribute

To make Contribution :

  1. Fork this repository to your GitHub account.
  2. Clone the forked repository to your local machine: 
    git clone https://github.com/your-username/Innovate-with-Open-Source.git
  3. Create a new branch for your contribution: 
    git checkout -b contributor/your-name
  4. Make your changes in the Snippet of Code.
  5. Commit your changes and push them to your forked repository: 
    git add .
git commit -m "Add your meaningful commit message here"
git push origin contributor/your-name
  6. Create a Pull Request (PR) from your forked repository to this main repository.
  7. Your PR will be reviewed and merged if everything is in order.
├── app
│   ├── fonts
│   ├── favicon.ico
│   ├── globals.css
│   ├── layout.js
│   └── page.js
├── components
|   ├── ui
|   |    └── button.jsx
|   ├── cards.jsx                        #Contributors card ui
|   ├── footer.jsx                       #Footer of the Website
|   ├── hero.jsx                         #Welcome Page of the Website
|   ├── howtocon.jsx                     #Contribution Steps
|   ├── Navbar.jsx                       #Header of the Website
|   └── section.jsx
└── lib
    ├── data.js                          #First Contributors Move here 👋🏻
    └──utils.js

📝 Contribution Guidelines

Please follow these guidelines to make sure your contributions are consistent and helpful:

  • Ensure your code adheres to the project’s coding standards and style.
  • Add comments to explain complex code or decisions made.
  • Test your changes locally to ensure they work as expected.
  • Keep pull requests small and focused on a single contribution.

🎯 Quick Tips

  • Remember to always pull the latest changes from the main repository before making a new branch.
  • Write clear and concise commit messages.
  • Be respectful and open to feedback during the PR review process.
  • Have fun contributing!

Thank you for contributing to Innovate-with-Open-Source and being part of Hacktoberfest! Let's build something amazing together. 🌟