Skip to content

Latest commit

 

History

History
103 lines (51 loc) · 4.32 KB

README.md

File metadata and controls

103 lines (51 loc) · 4.32 KB
Raw

Open source:octocat: contribution for beginners

Know Your Code (1)

GitHub GitHub contributors GitHub issues GitHub closed issues GitHub pull requests GitHub closed pull requests GitHub last commit

This repository targets beginners:beginner: to guide them about open source, help them make their first contribution and help them know their code.

The following text explains how to push your local changes to the remote repository and how to create a Pull Request. If you already know that, just go through the Contributing Guidelines and you are ready to contribute!

This Project is

Prerequisites:

  1. A github account

  2. Git CLI

  3. An IDE:

    i. VSCode

    ii. Sublime for HTML, CSS and JS

    iii. Or any other IDE of your choice

How to contribute:

  1. Fork the repository

    To fork the repository click on the fork button on the top right corner of the repository section. It will create a copy of that repository in your account.

    fork

  2. Open Git CLI and follow these steps:

  3. Clone the repository

    i. Copy the URL of the repository.

    clone

    ii. To copy the contents of the repository in your local git clone <paste the copied url from github>

    WhatsApp Video 2021-11-06 at 3 43 55 AM

    Then you can open the cloned repository in any IDE and make changes.

  4. Switch to the branch you want to contribute to.

    git checkout <your-branch-name>

  5. Read the repository's contributing guide before starting any editing.

  6. Make changes in the contributing branch.

  7. Stage the changes git add <your-full-file-name> (with path) (to stage all files, use git add .)

  8. Commit the changes git commit -m "Your message"

  9. Push the changes git push -u origin <your-branch-name>

  10. Create an issue in the repository describing the changes you want to make. To know how to do that, see the Contributing Guidelines.

  11. Pull request(requesting the project creator to add/merge your changes to the main repository)

    i. Ensure that you make PR to the right branch.

    ii. Add relevent title and description to your pull request that explains the changes you made appropriately.

    iii. Click on create pull request button.

    contribute

    pr

    iv. Make sure to mention the issue you want to fix in the description of your pull request. (Format :Refer to issue #<issue-number>)

  12. Now you just have to wait for the project creator/owner to review your request and merge your changes to the original code. Congratulations on making your very first open-source contribution!:fist_right::fist_left:

This repository is a collaborative project and is handeled by @lovishprabhakar