Skip to content

Latest commit

 

History

History
61 lines (39 loc) · 2 KB

contribution.md

File metadata and controls

61 lines (39 loc) · 2 KB

Contribution Guide

Welcome to the Simple Contribution project! 🎉

Here is a step-by-step guide to making your first contribution to this project. If you're new to GitHub, this guide will help you understand the basics of contributing and getting involved in the open-source community.

Step 1: Fork the repository

To make changes to this project, you first need to create your own copy by forking the repository. Simply click the Fork button at the top-right of this page.

Step 2: Clone your fork

Once you have forked the repository, clone your fork to your local machine by running the following command in your terminal:

git clone https://github.com/your-username/simple-contribution.git

Step 3: Add your details

  • Open the cardDetails.json file in your code editor.
  • Add a new entry to the JSON file with your details. Simply copy the format below and modify it with your own details:
{
  "name": "Your Name",
  "profession": "Your Profession",
  "quote": "\"Your favourite quote\" - Said by You",
  "github": "https://github.com/yourusername",
  "linkedin": "https://linkedin.com/in/yourprofile",
  "email": "mailto:youremail@example.com"
}

Make sure you do not remove anyone else's details—just add yours below the existing entries.

Step 4: Commit your changes

After adding your details, you need to save the changes and commit them to your forked repository:

git add cardDetails.json
git commit -m "Added my details"

Step 5 : Push your changes

Now that your changes are committed, push them to your remote GitHub repository:

git push origin main

Step 6: Create a pull request

Once your changes are pushed to your forked repository on GitHub, navigate to your fork on GitHub, and click on the New Pull Request button. Write a meaningful description of your contribution and submit the PR.

That's it! 🎉 Once your pull request is reviewed and merged, your details will be live on the Simple Contribution website!

Thank you for contributing!