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

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

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.


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

    CodeSmashers Community


    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

    Owner
    Arpit Jain
    Full Stack Web Developer with Python Flask and Django. 3 star Competitive Programmer on Codechef.
    Arpit Jain
    Gtech μLearn Sample_bot

    Ser_bot Gtech μLearn Sample_bot Do Greet a newly joined member in a channel (random message) While adding a reaction to a message send a message to a

    Jerin Paul 1 Jan 19, 2022
    Python For Finance Cookbook - Code Repository

    Python For Finance Cookbook - Code Repository

    Packt 544 Dec 25, 2022
    Speed up Sphinx builds by selectively removing toctrees from some pages

    Remove toctrees from Sphinx pages Improve your Sphinx build time by selectively removing TocTree objects from pages. This is useful if your documentat

    Executable Books 8 Jan 04, 2023
    Automated generation of real Swagger/OpenAPI 2.0 schemas from Django REST Framework code.

    drf-yasg - Yet another Swagger generator Generate real Swagger/OpenAPI 2.0 specifications from a Django Rest Framework API. Compatible with Django Res

    Cristi Vîjdea 3k Dec 31, 2022
    Tampilan - Change Termux Appearance With Python

    Tampilan Gambar usage pkg update && pkg upgrade pkg install git && pkg install f

    Creator Lord-Botz 1 Jan 31, 2022
    script to calculate total GPA out of 4, based on input gpa.csv

    gpa_calculator script to calculate total GPA out of 4 based on input gpa.csv to use, create a total.csv file containing only one integer showing the t

    Mohamad Bastin 1 Feb 07, 2022
    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

    Polygon 2 Jan 31, 2022
    A Json Schema Generator

    JSON Schema Generator Author : Eru Michael About A Json Schema Generator. This is a generic program that: Reads a JSON file similar to what's present

    1 Nov 10, 2021
    Yet Another MkDocs Parser

    yamp Motivation You want to document your project. You make an effort and write docstrings. You try Sphinx. You think it sucks and it's slow -- I did.

    Max Halford 10 May 20, 2022
    Easy OpenAPI specs and Swagger UI for your Flask API

    Flasgger Easy Swagger UI for your Flask API Flasgger is a Flask extension to extract OpenAPI-Specification from all Flask views registered in your API

    Flasgger 3.1k Dec 24, 2022
    Explorative Data Analysis Guidelines

    Explorative Data Analysis Get data into a usable format! Find out if the following predictive modeling phase will be successful! Combine everything in

    Florian Rohrer 18 Dec 26, 2022
    A website for courses of Major Computer Science, NKU

    A website for courses of Major Computer Science, NKU

    Sakura 0 Oct 06, 2022
    📖 Generate markdown API documentation from Google-style Python docstring. The lazy alternative to Sphinx.

    lazydocs Generate markdown API documentation for Google-style Python docstring. Getting Started • Features • Documentation • Support • Contribution •

    Machine Learning Tooling 118 Dec 31, 2022
    A curated list of awesome mathematics resources

    A curated list of awesome mathematics resources

    Cyrille Rossant 6.7k Jan 05, 2023
    Explicit, strict and automatic project version management based on semantic versioning.

    Explicit, strict and automatic project version management based on semantic versioning. Getting started End users Semantic versioning Project version

    Dmytro Striletskyi 6 Jan 25, 2022
    An introduction to hikari, complete with different examples for different command handlers.

    An intro to hikari This repo provides some simple examples to get you started with hikari. Contained in this repo are bots designed with both the hika

    Ethan Henderson 18 Nov 29, 2022
    Python Eacc is a minimalist but flexible Lexer/Parser tool in Python.

    Python Eacc is a parsing tool it implements a flexible lexer and a straightforward approach to analyze documents.

    Iury de oliveira gomes figueiredo 60 Nov 16, 2022
    💡 Catatan Materi Bahasa Pemrogramman Python

    Repository catatan kuliah Andika Tulus Pangestu selama belajar Dasar Pemrograman dengan Python.

    0 Oct 10, 2021
    Data Inspector is an open-source python library that brings 15++ types of different functions to make EDA, data cleaning easier.

    Data Inspector Data Inspector is an open-source python library that brings 15 types of different functions to make EDA, data cleaning easier. Author:

    Kazi Amit Hasan 38 Nov 24, 2022
    Fully reproducible, Dockerized, step-by-step, tutorial on how to mock a "real-time" Kafka data stream from a timestamped csv file. Detailed blog post published on Towards Data Science.

    time-series-kafka-demo Mock stream producer for time series data using Kafka. I walk through this tutorial and others here on GitHub and on my Medium

    Maria Patterson 26 Nov 15, 2022