First Contribution
This project is for those who are new to open-source and looking for make their first contribution.
Follow the steps below :-
If you don't have GIT installed, refer this tutorial
Git Setup Guide
To initialise Git, write
git init
1. Configure your local Git
git config --global user.name "github username"
git config --global user.email "email address"
2. Go to the first-contribution repository and Fork it.
-
A fork is a rough copy of a repository. Forking a repository allows you to freely test and debug with changes without affecting the original project. One of the excessive use of forking is to propose changes for bug fixing.
-
Click on Code Button and copy the URL of your forked Repository
3. Switch to your Git bash window, and enter the following :
- Clone the Forked project on your local system
git clone https://github.com/HITK-2025/first-contribution.git
- Make the changes
cd first-contribution/data/
Open contributors.js in your favourite text editor and add a new object below the existing objects in the format given below.
{
name : "Your Name",
branch : "Your Branch",
roll : "Your Roll (without double quotes)",
year : "Passing year (without double qotes)",
linkedin : "linkedin profile link",
github : "github account link",
gender : "your gender"
},
4. Creating a Pull request
Create a branch
-
A branch is designed to encapsulate a group of changes. These changes might be thrown away, entirely rewritten or in the majority of cases they’ll be promoted into the main history of the codebase - via a merge.
-
Creating a branch
git branch branch_name
- Checkout to the created branch
git checkout branch_name
- Now add the files using the git command
git add .
- Commit the changes to the local project
git commit -m "Added my data"
- Push the changes to your forked github repo
git push origin branch_name
5. Final Steps
- Open your forked git repository, you will get a message like as shown in the figure (if not then refresh the page).
Click on "Contribute"
Now click on "Open pull request"
Click on "Create pull request"
Click on "Create pull request"
You may add a Comment to your Pull Request