Contributing Instructions
Contributing to an Open Source project can be scary, specially if it's your first time. Don't worry, we have your back! Just follow the instructions below and get started on your OpenSource journey today.
Step 1. Initialize and Configure Git
The first thing to do is to initialize Git. Before proceeding, make sure you have GIT installed in your local machine. If you do not have GIT installed, refer to this tutorial
To initialize Git, write:
git init
To configure your local Git username
git config --global user.name “github username”
To configure your local Git password
git config --global user.name “github password”
Step 2. Fork the Repository
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.
So go to the first-contributions repository and fork the repository by clicking on the 'Fork' button as show below.
Click on the 'Code' button and copy the URL of your forked Repository
Step 3. Clone the Repository
The next step is to clone the repository. When you clone a repository, you copy the repository from GitHub.com to your local machine. Cloning a repository pulls down a full copy of all the repository data that GitHub.com has at that point in time, including all versions of every file and folder for the project.
Open up Git bash on your local machine and enter the following command to clone the forked repository on your local system:
git clone https://github.com/HITK-2025/first-contribution.git
Enter the following command to change your directory:
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.
Now open Contributors.md in a text editor and add your name and your github link below the exisiting one in given format
- [your_name](your Github url)
Step 4. Create a Pull Request
The next step is to create a pull request. This is one of the most important steps. Follow the steps below to open up your first 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. Create a branch using the following command.
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
Step 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
Add a meaningful title and comment and then click on "Create pull request
You will get message similar to as shown below in the picture which means that you have sucessfully made a pull request !
Now, you can see your data into Contributors.md and contributors.js
Want to setup the this project locally?
If you want to setup this project locally, then refer to this tutorial