step by step guide for beginners for getting started with open source

Arpit Jain

Last update: Jan 3, 2023

Related tags

Overview

Step-by-Step Guide for beginners for getting started with Open-Source

Here The Contribution Begins 💻

If you are a beginner then this repository is for you. By this tutorial you are going to learn how to make your First Pull Request for sure.

👋 Join our discord community CodeSmashers

⭐ STAR THIS REPOSITORY THIS WILL PAY OFF MY WORK

1. The first thing you need is Git installed on your system, if it is not installed then download it as per your OS and install it.

Git Setup :-

Download Git as per your OS.
Git installation Video as per your OS.
Install Git
Open the Git Bash ( Right Click )
Run the Commands

$ git config --global user.name "Your Name"

$ git config --global user.email [email protected]

$ git config --list

You should be able to see your entered name and email under user.name & user.email

2. You should have an account on GitHub if you you dont't have an account then simply make it.

3. You will need a text editor accoring to your comfort , I prefer Vs code

Download Vs Code as per your OS.
Vs Code installation Video as per your OS.
Install it.

4. Now you just have to setup the project from GitHub to your local system.

Setting Project on your Local System :-

Fork this Repository or Project
This will create a copy of this repository in your account.

Copy the link of the Repository

Open Git bash where you want to clone the project and clone it
Clone it
Run Command and Hit Enter
```
git clone 
     

     
```
In this case it is
git clone https://github.com/arpit456jain/Getting-Started-with-open-source.git
After you hit enter you will notice that some downloading will start. It's actually cloning of repo form your GitHub repository to your local system.

After this you will notice a folder is created with the name of repository

Then just close the Git bash and open this folder and open VS code here

5. Now Make necessary changes and commit them , lets say you have to add your name in readme , you already set up the project in local system . Now before starting your work always rembember to pull latest change from the main Repo.

Fetch And Merge

Pull these changes in your local system

git pull origin master

make a new branch and then make the changes , then commit them. make sure to commit to the new branch
Never commit in master branch

git checkout -b new_branch_name
git add -A
git commit -a -m "message"

After commiting your changes on your local host you have to push that changes to GitHub , make sure you push the new branch

git push origin new_branch_name

6. Make the Pull Request

when you push the changes you will notice a new branch will be created on GitHub and there will be a green button for creating pull request. Click on it.

After this a new page will be open like this

Now add a title and description of your PR and click on create pull request.

Congrats 🎉 your Pull Request is created

Some Common Error And Their Solutions

1. Updates were rejected or failed to push some refs.

This is most common error you will find and its pretty easy to solve .

Solution: You just have to pull latest changes to your local system first and then you can push them

git pull origin master

Note : if your repo is a forked one and its some commit behind then first fetch n merge then pull changes

Common Git Commands you should know!!!

1. Git checkout

You can use the checkout command to switch the branch that you are currently working on.

git checkout

2. Git init

This is the command you need to use if you want to start a new empty repository or to reinitialize an existing one in the project root. It will create a .git directory with its subdirectories.

git init

3. Git diff

You can use this command to see the unstaged changes on the current branch.

git diff

If you want to see the staged changes.

git diff --staged

Or you can compare two branches:

gif diff

4. Git add

This is the command you need to use to stage changed files. You can stage individual files.

git add

You can also stage all files.

git add .

5. Git branch

Using git branch will list all the branches of the repository.

git branch

Or you can use it to create a new branch, without checking it out.

git branch

To delete a branch.

git branch -d

6. Git log

If you want to see what you have committed till now.

git log

If you want to see last 5 commits among 100000 commits.

git log -p -1

7. Git clear

To clean git bash.

git clear

What if I have Merge Conflicts?

A GitHub conflict is when people make changes to the same area or line in a file. This must be fixed before it is merged in order to prevent collision in the main branch.

To read more about this, go to Github Docs - About Merge Conflicts
To find out about how to fix a Git Conflict, go to Github Docs - Resolve Merge Conflict

Now just make a Pull Request and add your name in Read me file.

CodeSmashers Community

A
- Arpit Jain
- Ankita Puri
- Adarsh Navneet Sinha
B
C
D
E
F
G
H
I
J
K
- Km Astha Rani
L
M
N
O
P
Q
R
S
- Siddharth Parashar
T
U
V
W
X
Y

-Yanala shivaprasad reddy
Z

Project Admin ❤️

_{Arpit Jain}

_{Ankita Puri}

✨ Contributors

Thanks go to these Wonderful People 👨🏻‍💻: 🚀

Contributions of any kind are welcome!

Open Source Programs click here

show some ❤️ by giving the star to this repo

Comments

Website Link in about section not Working
Issue Type:

[x] Bug Report

[ ] Feature Request

[x] Documentaion

Describe the bug

The website link in the about section is not working

Possible solution

Update the website link to the correct one

Screenshots

hacktoberfest
opened by Amandeep404 6
fixed the images not showing on README.md
Description

Added the proper syntax to call images on markdown and they are clearly displayed.

Fixes # (issue no.) #137

Type of change

[x] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system: Mac

Version: 10.11.6

Text-editors used: Vs code

Checklist:

[x] I have made corresponding changes to the documentation

[x] My changes generate no new warnings

[x] I have added tests that prove my fix is effective or that my feature works

[x] New and existing unit tests pass locally with my changes

[x] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK

hacktoberfest-accepted GDSC
opened by GloriaOkeke 4
I have updated the name.txt and style_links.json
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[x] Bug fix (non-breaking change which fixes an issue)

[x] New feature (non-breaking change which adds functionality)

[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[x] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[x] My code follows the style guidelines of this project

[x] I have performed a self-review of my own code

[x] I have commented my code, particularly in hard-to-understand areas

[x] I have made corresponding changes to the documentation

[x] My changes generate no new warnings

[x] I have added tests that prove my fix is effective or that my feature works

[x] New and existing unit tests pass locally with my changes

[x] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by parag477 4
WIP: Beautify The ReadMe.
Hi! I was going through the readme and It is too hard to read. Here are a few of them problems.

Inconsistent spaces and line breaks.

Inconsistent screenshot sizes.

Inconsistent Alignment.

Inconsistent Visual Hierarchy.
opened by himansheeeesh 4
images folder
Description

All images are put in images folder.

Fixes # (issue no.)

#133

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[x] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system: windows

Version: 11

Text-editors used: vscode

Checklist:

[x] My code follows the style guidelines of this project

[x] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
hacktoberfest-accepted
opened by SurajKD 3
i have made my contribution in open source by completing the given t…
…asks of updateing name.txt and stylelinksjson

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by Niharika2608 3
Add my name
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by Anubhavgupta14 3
Update README.md
Adding my name

Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[x] My code follows the style guidelines of this project

[x] I have performed a self-review of my own code

[x] I have commented my code, particularly in hard-to-understand areas

[x] I have made corresponding changes to the documentation

[x] My changes generate no new warnings

[x] I have added tests that prove my fix is effective or that my feature works

[x] New and existing unit tests pass locally with my changes

[x] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by shivamagarwal2510 3
Update README.md
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by hackbysarthak03 3
added name in readme
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by kishankrishna1 3
Added name in readme
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
GDSC
opened by TusharKesarwani 3
messssage test
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[x] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[x] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK
opened by neighburrito 2
Update style.css
Description

Please include a summary of the change and which issue is fixed. Please also include relevant motivation and context. List any dependencies that are required for this change.

Fixes # (issue no.)

Type of change

[ ] Bug fix (non-breaking change which fixes an issue)

[ ] New feature (non-breaking change which adds functionality)

[ ] Breaking change (fix or feature that would cause existing functionality to not work as expected)

[ ] This change requires a documentation update

Explain the Testing instructions

Test Configuration:

Operating system:

Version:

Text-editors used:

Checklist:

[ ] My code follows the style guidelines of this project

[ ] I have performed a self-review of my own code

[ ] I have commented my code, particularly in hard-to-understand areas

[ ] I have made corresponding changes to the documentation

[ ] My changes generate no new warnings

[ ] I have added tests that prove my fix is effective or that my feature works

[ ] New and existing unit tests pass locally with my changes

[ ] Any dependent changes have been merged and published in downstream modules

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK , I have made some changes.
opened by Aliksarkar18 2
images on the README.md not showing
Issue Type:

[ ] Bug Report

[ ] Feature Request

[.] Documentaion

Describe the bug

Images on the README.md file are not showing

Possible solution

Take screenshots and upload at proper places on the README.md, with the right markdown syntax

Screenshots

hacktoberfest
opened by GloriaOkeke 5

Owner

Arpit Jain

Full Stack Web Developer with Python Flask and Django. 3 star Competitive Programmer on Codechef.

GitHub

A comprehensive and FREE Online Python Development tutorial going step-by-step into the world of Python.

FREE Reverse Engineering Self-Study Course HERE Fundamental Python The book and code repo for the FREE Fundamental Python book by Kevin Thomas. FREE B

7 Mar 19, 2022

A simple tutorial to get you started with Discord and it's Python API

Hello there Feel free to fork and star, open issues if there are typos or you have a doubt. I decided to make this post because as a newbie I never fo

1 Nov 1, 2021

This tutorial will guide you through the process of self-hosting Polygon

Hosting guide This tutorial will guide you through the process of self-hosting Polygon Before starting Make sure you have the following tools installe

2 Jan 31, 2022

Python script to generate Vale linting rules from word usage guidance in the Red Hat Supplementary Style Guide

ssg-vale-rules-gen Python script to generate Vale linting rules from word usage guidance in the Red Hat Supplementary Style Guide. These rules are use

1 Jan 13, 2022

Obmovies - A short guide on setting up the system and environment dependencies required for ob's Movies database

1 Jan 4, 2022

Hasköy is an open-source variable sans-serif typeface family

Hasköy Hasköy is an open-source variable sans-serif typeface family. Designed with powerful opentype features and each weight includes latin-extended

67 Jan 4, 2023

Mozilla Campus Club CCEW is a student committee working to spread awareness on Open Source software.

Mozilla Campus Club CCEW is a student committee working to spread awareness on Open Source software. We organize webinars and workshops on different technical topics and making Open Source contributions.

8 Jun 15, 2022

An open source utility for creating publication quality LaTex figures generated from OpenFOAM data files.

foamTEX An open source utility for creating publication quality LaTex figures generated from OpenFOAM data files. Explore the docs » Report Bug · Requ

1 Dec 19, 2021

An open-source script written in python just for fun

Owersite Owersite is an open-source script written in python just for fun. It do

7 Sep 21, 2022

EasyModerationKit is an open-source framework designed to moderate and filter inappropriate content.

EasyModerationKit is a public transparency statement. It declares any repositories and legalities used in the EasyModeration system. It allows for implementing EasyModeration into an advanced character/word/phrase detection system.

1 Jan 16, 2022

💻An open-source eBook with 101 Linux commands that everyone should know

This is an open-source eBook with 101 Linux commands that everyone should know. No matter if you are a DevOps/SysOps engineer, developer, or just a Linux enthusiast, you will most likely have to use the terminal at some point in your career.

0 Oct 29, 2022

Automatically open a pull request for repositories that have no CONTRIBUTING.md file

automatic-contrib-prs Automatically open a pull request for repositories that have no CONTRIBUTING.md file for a targeted set of repositories. What th

8 Oct 20, 2022

The source code that powers readthedocs.org

Welcome to Read the Docs Purpose Read the Docs hosts documentation for the open source community. It supports Sphinx docs written with reStructuredTex

7.4k Dec 25, 2022

Canonical source repository for PyYAML

PyYAML - The next generation YAML parser and emitter for Python. To install, type 'python setup.py install'. By default, the setup.py script checks

2k Jan 1, 2023

Source Code for 'Practical Python Projects' (video) by Sunil Gupta

Apress Source Code This repository accompanies %Practical Python Projects by Sunil Gupta (Apress, 2021). Download the files as a zip using the green b

2 Jun 1, 2022

A tutorial for people to run synthetic data replica's from source healthcare datasets

Synthetic-Data-Replica-for-Healthcare Description What is this? A tailored hands-on tutorial showing how to use Python to create synthetic data replic

11 Mar 22, 2022

graphical orbitational simulation of solar system planets with real values and physics implemented so you get a nice elliptical orbits. you can change timestamp value or scale from source code idc.

solarSystemOrbitalSimulation graphical orbitational simulation of solar system planets with real values and physics implemented so you get a nice elli

3 Mar 3, 2022

step by step guide for beginners for getting started with open source

Related tags

Overview

Step-by-Step Guide for beginners for getting started with Open-Source

Here The Contribution Begins 💻

If you are a beginner then this repository is for you. By this tutorial you are going to learn how to make your First Pull Request for sure.

⭐ STAR THIS REPOSITORY THIS WILL PAY OFF MY WORK

1. The first thing you need is Git installed on your system, if it is not installed then download it as per your OS and install it.

Git Setup :-

2. You should have an account on GitHub if you you dont't have an account then simply make it.

3. You will need a text editor accoring to your comfort , I prefer Vs code

4. Now you just have to setup the project from GitHub to your local system.

Setting Project on your Local System :-

5. Now Make necessary changes and commit them , lets say you have to add your name in readme , you already set up the project in local system . Now before starting your work always rembember to pull latest change from the main Repo.

6. Make the Pull Request

Some Common Error And Their Solutions

1. Updates were rejected or failed to push some refs.

Common Git Commands you should know!!!

1. Git checkout

2. Git init

3. Git diff

4. Git add

5. Git branch

6. Git log

7. Git clear

What if I have Merge Conflicts?

A GitHub conflict is when people make changes to the same area or line in a file. This must be fixed before it is merged in order to prevent collision in the main branch.

To read more about this, go to Github Docs - About Merge Conflicts

To find out about how to fix a Git Conflict, go to Github Docs - Resolve Merge Conflict

Now just make a Pull Request and add your name in Read me file.

CodeSmashers Community

A

B

C

D

E

F

G

H

I

J

K

L

M

N

O

P

Q

R

S

T

U

V

W

X

Y

Z

Project Admin ❤️

✨ Contributors

Open Source Programs click here

show some ❤️ by giving the star to this repo

Comments

Issue Type:

Describe the bug

Possible solution

Screenshots

Description

Type of change

Explain the Testing instructions

Checklist:

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK

Description

Type of change

Explain the Testing instructions

Checklist:

ATTACH SCREEN-SHOTS / DEPLOYMENT LINK

Description

Type of change

Explain the Testing instructions

Checklist: