Photo by Desola Lanre-Ologun on Unsplash
How to Contribute to Open Source Project
In this article, you will learn to contribute to open-source projects on the Internet
Table of contents
- Steps to Contributing to Open-source projects:
- (Step 1) Pick an open-source project to contribute to
- (Step 2) Read the CONTRIBUTING.md and README.md files
- (Step 3) Fork the Repository
- (Step 4) Clone the Repository
- (Step 5) Create a new branch
- (Step 6) Make necessary changes and commit those changes locally
- (Step 7) Push Changes to GitHub
- (Step 8) Update the local repository
- (Step 9) Submit changes for review
Open source project is any project freely available for everyone to use or modify. Contributing to these projects will help improve the project and you the developer.
Steps to Contributing to Open-source projects:
- Pick an open-source project to contribute to.
- Read the CONTRIBUTING.md and README.md files
- Fork the Repository
- Clone the Repository
- Create a new branch
- Make necessary changes and commit those changes locally
- Push Changes to GitHub
- Update the local repository
- Submit changes for review
(Step 1) Pick an open-source project to contribute to
Pick an open-source project on the internet you have used or are interested in. You can check this link for beginners' open-source projects:
github.com/mungell/awesome-for-beginners
github.com/firstcontributions/first-contrib..
We will contribute to this project: github.com/firstcontributions/first-contrib..
(Step 2) Read the CONTRIBUTING.md and README.md files
Read the README.md and CONTRIBUTING.md file to get a sense of what the project is about and how to contribute to the project. At this stage, you want to get every information necessary about the project.
For the project we are contributing to: github.com/firstcontributions/first-contrib.., the README.md file explains that the project helps beginners make their first contribution to open-source by adding their names to Contributors.md file.
We will stick to the information we got from the README.md file. We will add our name to the Contributors.md file, to contribute to the project. Okay guys let's start coding!!
(Step 3) Fork the Repository
To Fork a repository mean to make a copy of a project or repository in your own GitHub account. On the project we want to contribute to: github.com/firstcontributions/first-contrib.. click on the Fork button, It will take you to a page as below to Create a new fork. Click on Create fork, which will take you to your own GitHub account having the project
Below is my Github account with the project. Check the link on your browser and notice your username is there.
(Step 4) Clone the Repository
This will make a local copy of the project on your computer. Copy the URL of the project. Notice your username in the URL
and run the following commands on your terminal(command prompt-window users) to make a copy of the project on your Desktop.
cd desktop
git clone https://github.com/emmakodes/first-contributions.git
Notice .git added to the URL
(Step 5) Create a new branch
Go to your Desktop you will find a folder "first-contributions", Open the folder with your favorite code editor(visual studio code, pycharm etc). Open the terminal and run the following command
git branch my-new-branch
Executing the above command will isolate your code so that you can make your changes and then merge back to the main code. Most times, you will want to use a more descriptive name instead of my-new-branch
Next, run below to switch to that branch
git checkout my-new-branch
(Step 6) Make necessary changes and commit those changes locally
One way of contributing to the project is by adding our names to Contributors.md. Open the Contributors.md file and add your name in between other names.
Mine added.
Run the following command on the terminal to add and commit the new change
git add Contributors.md
git commit -m "Add emmakodes to Contributors list"
(Step 7) Push Changes to GitHub
Run the following command to push changes to the current branch of our forked repository.
git push --set-upstream origin my-new-branch
You should see the response above when you execute the command on your terminal
(Step 8) Update the local repository
Since we are contributing to an open-source project, other developers might have contributed or applied changes to the online project since the last time we check, so we have to get those changes before we apply for our own contribution to be added to avoid conflicts. Run the following command on your terminal:
git remote add upstream https://github.com/firstcontributions/first-contributions.git
github.com/firstcontributions/first-contrib.. should be the URL of the repo you forked from. upstream is an alias for the URL. Run the following command:
git fetch upstream
git checkout main
git merge upstream/main
Above, we set up and fetch changes from the GitHub repo we forked from and then merge those changes to our local repo.
(Step 9) Submit changes for review
We can submit our changes for it to be reviewed by the maintainers of the open-source project. Go to your GitHub account, then Your repositories, access the first-contributions repositories, and click on Compare and pull request, It will take you to the following page, you can add comments and then click on Create pull request. When you click on Create pull request, the maintainers of the project will receive a notification to merge your changes to the main project. They may decide to merge if everything is okay or make a comment for you to make changes to your pull request.
If they merge your changes, then congratulations on making your first open-source contribution. Go further, look for more projects and contribute to those projects.