Logo

dev-resources.site

for different kinds of informations.

A guide to your first open source contribution 🚀✨

Published at
9/12/2023
Categories
beginners
github
opensource
contributorswanted
Author
gerryaballa
Author
11 person written this
gerryaballa
open
A guide to your first open source contribution 🚀✨

This project aims to simplify and guide the way beginners make their first contribution. If you are looking to make your first contribution, follow the steps below.

Requirements

Get the Project repository here
Install Git on your machine

1. Fork this repository

Fork this repository by clicking on the fork button on the top of this page. This will create a copy of this repository in your account.

fork this repository

2. Clone the repository

Now clone the forked repository to your machine. Go to your GitHub account, open the forked repository, click on the code button and then click the copy to clipboard icon.

clone the repository

Open a terminal and run the following git command:

git clone "url you just copied"
Enter fullscreen mode Exit fullscreen mode

Where "url you just copied" (without the quotation marks) is the url to this repository (your fork of this project). See the previous steps to obtain the url.

copy repository url

For example:

git clone [email protected]:this-is-you/initial-contribution.git
Enter fullscreen mode Exit fullscreen mode

where this-is-you is your GitHub username. Here you're copying the contents of the first-contributions repository on GitHub to your computer.

3. Create a branch

Change to the repository directory on your computer (if you are not already there):

cd initial-contribution
Enter fullscreen mode Exit fullscreen mode

Now create a branch using the git switch command:

git switch -c your-new-branch-name
Enter fullscreen mode Exit fullscreen mode

For example:

git switch -c add-automation-mantis
Enter fullscreen mode Exit fullscreen mode

4. Make changes and commit the changes

Now open Contributions.md file in a text editor, add your name to it. Don't add it at the beginning or end of the file. Put it anywhere in between. Now, save the file.
If you go to the project directory and execute the command git status, you'll see there are changes.

Add those changes to the branch you just created using the git add command:

git add Contributions.md
Enter fullscreen mode Exit fullscreen mode

Now commit those changes using the git commit command:

git commit -m "Add your-name to Contributions list"
Enter fullscreen mode Exit fullscreen mode

replacing your-name with your name.

5. Push changes to github

Push your changes using the command git push:

git push -u origin your-branch-name
Enter fullscreen mode Exit fullscreen mode

replacing your-branch-name with the name of the branch you created earlier.

If you get any errors while pushing, click here:

6. Submit your changes for review

If you go to your repository on GitHub, you'll see a Compare & pull request button. Click on that button.

submit the changes

Now submit the pull request.

create a pull request

What next

Soon I'll be merging all your changes into the main branch of this project. You will get a notification email once the changes have been merged.
You are allowed to delete the created branch.

delete the branch

Congrats! You just completed the standard fork -> clone -> edit -> pull request workflow that you'll often encounter as a contributor!

Tip!

Complete this twice to earn your first Github badge

contributorswanted Article's
30 articles in total
Favicon
Sample Programs Repo Celebrates 1,000 Code Snippets
Favicon
🚀 Calling All Innovators and Developers!
Favicon
Developers looking for charitable projects
Favicon
IESCO Bill Checking Online
Favicon
Build the Future of AP CSP with Spindle
Favicon
Open Source Unleashed: Benefits and Contributions
Favicon
AI-Powered PR Review Bot - Looking for Contributors!
Favicon
8 EASY WAYS ON HOW TO CREATE A GOOGLE MAIL (GMAIL) ACCOUNT IN 2024
Favicon
Why Watching Movies at Home is an Audio Nightmare—and How We Could Fix It with Smart Sound Tech
Favicon
Hacktoberfest 2024: Code, Collaborate, and Conquer!
Favicon
NPM package – community-health-files
Favicon
Why You Should Pay for Open Source
Favicon
SaaS Management System
Favicon
Implement a Global Handler for UserNotFoundException
Favicon
Enhance Your Debugging Skills by Contributing to the Journal REST API
Favicon
Introducing Vortex Linux: A Secure and Flexible Distribution in Development—Seeking Contributors!
Favicon
How to Start Contributing to Open Source: A Simple Roadmap
Favicon
Benefits of Rewarding Issues with Opire.
Favicon
Calling All Developers! Contribute to golly: Empower the Go Community Together 🚀
Favicon
Guia para Iniciantes: Contribuindo em Projetos Open Source Passo a Passo
Favicon
Ask everybody to share experiences on analytics
Favicon
🚀 Exciting Open-Source Opportunities in 2024! 🌐
Favicon
Looking for Open-source contribution opportunities
Favicon
Make your Js Components in seconds
Favicon
Starting your career with 40 commits
Favicon
A guide to your first open source contribution 🚀✨
Favicon
Unleash the Magic: Conquer Hacktoberfest 2023!
Favicon
All about Hactoberfest'23
Favicon
Who's looking for open source contributors? (week 61)
Favicon
Elevate Your Hacktoberfest Experience: MindsDB's Grand Prize Bonanza!

Featured ones: