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
    Python Advanced --- numpy, decorators, networking

    Python Advanced --- numpy, decorators, networking (and more?) Hello everyone 👋 This is the project repo for the "Python Advanced - ..." introductory

    Andreas Poehlmann 2 Nov 05, 2021
    A collection of online resources to help you on your Tech journey.

    Everything Tech Resources & Projects About The Project Coming from an engineering background and looking to up skill yourself on a new field can be di

    Mohamed A 396 Dec 31, 2022
    Generate modern Python clients from OpenAPI

    openapi-python-client Generate modern Python clients from OpenAPI 3.x documents. This generator does not support OpenAPI 2.x FKA Swagger. If you need

    555 Jan 02, 2023
    API Documentation for Python Projects

    API Documentation for Python Projects. Example pdoc -o ./html pdoc generates this website: pdoc.dev/docs. Installation pip install pdoc pdoc is compat

    mitmproxy 1.4k Jan 07, 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
    Python For Finance Cookbook - Code Repository

    Python For Finance Cookbook - Code Repository

    Packt 544 Dec 25, 2022
    204-python-string-21BCA90 created by GitHub Classroom

    204-Python This repository is created for subject "204 Programming Skill" Python Programming. This Repository contain list of programs of python progr

    VIDYABHARTI TRUST COLLEGE OF BCA 6 Mar 31, 2022
    Software engineering course project. Secondhand trading system.

    PigeonSale Software engineering course project. Secondhand trading system. Documentation API doumenatation: list of APIs Backend documentation: notes

    Harry Lee 1 Sep 01, 2022
    Resource hub for Obsidian resources.

    Obsidian Community Vault Welcome! This is an experimental vault that is maintained by the Obsidian community. For best results we recommend downloadin

    Obsidian Community 320 Jan 02, 2023
    Always know what to expect from your data.

    Great Expectations Always know what to expect from your data. Introduction Great Expectations helps data teams eliminate pipeline debt, through data t

    Great Expectations 7.8k Jan 05, 2023
    Type hints support for the Sphinx autodoc extension

    sphinx-autodoc-typehints This extension allows you to use Python 3 annotations for documenting acceptable argument types and return value types of fun

    Alex Grönholm 462 Dec 29, 2022
    Markdown documentation generator from Google docstrings

    mkgendocs A Python package for automatically generating documentation pages in markdown for Python source files by parsing Google style docstring. The

    Davide Nunes 44 Dec 18, 2022
    Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.

    Flask-Rebar Flask-Rebar combines flask, marshmallow, and swagger for robust REST services. Features Request and Response Validation - Flask-Rebar reli

    PlanGrid 223 Dec 19, 2022
    Data-science-on-gcp - Source code accompanying book: Data Science on the Google Cloud Platform, Valliappa Lakshmanan, O'Reilly 2017

    data-science-on-gcp Source code accompanying book: Data Science on the Google Cloud Platform, 2nd Edition Valliappa Lakshmanan O'Reilly, Jan 2022 Bran

    Google Cloud Platform 1.2k Dec 28, 2022
    Your Project with Great Documentation.

    Read Latest Documentation - Browse GitHub Code Repository The only thing worse than documentation never written, is documentation written but never di

    Timothy Edmund Crosley 809 Dec 28, 2022
    Quilt is a self-organizing data hub for S3

    Quilt is a self-organizing data hub Python Quick start, tutorials If you have Python and an S3 bucket, you're ready to create versioned datasets with

    Quilt Data 1.2k Dec 30, 2022
    Minimal reproducible example for `mkdocstrings` Python handler issue

    Minimal reproducible example for `mkdocstrings` Python handler issue

    Hayden Richards 0 Feb 17, 2022
    Dynamic Resume Generator

    Dynamic Resume Generator

    Quinten Lisowe 15 May 19, 2022
    100 Days of Code Learning program to keep a habit of coding daily and learn things at your own pace with help from our remote community.

    100 Days of Code Learning program to keep a habit of coding daily and learn things at your own pace with help from our remote community.

    Git Commit Show by Invide 41 Dec 30, 2022
    Assignments from Launch X's python introduction course

    Launch X - On Boarding Assignments from Launch X's Python Introduction Course Explore the docs » Report Bug · Request Feature Table of Contents About

    Javier Méndez 0 Mar 15, 2022