Skip to content

Latest commit

 

History

History
86 lines (45 loc) · 3.63 KB

CONTRIBUTING.md

File metadata and controls

86 lines (45 loc) · 3.63 KB

Wanna contribute?

Here are the simple steps for contributing to this repo;

  • READ CODE OF CONDUCT

Read the Code of Conduct before starting contributing.

  • Fork the repo

Firstly fork the repo to your own GitHub account by clicking the Fork button on the top-right corner. Still can’t find it, check the image below.

Screenshot 2021-09-26 at 12 59 29 AM

After the successful fork, you'll acknowledge a copy of this repo on your own.

  • Clone the repo

Now it's time to copy this repo to my own laptop/PC. To clone the repo you can write the below command in Git Bash

    > git clone <REPO_LINK_FROM_YOUR_ACCOUNT>

You can get the repo link from the Download section in the repo copied in your account. If you’re still facing problems check out the image below. Screenshot 2021-09-26 at 1 01 24 AM

  • Set up remote repo

  • When you clone your fork, it will automatically set your fork as the "origin" remote. Use git remote -v to show your current remotes. You should see the URL of your fork (which you copied in step 3) next to the word "origin". If you don't see the "origin" remote, you can add it using the git command below.

      > git remote add origin <REPO_LINK_FROM_YOUR_ACCOUNT>
    
  • Now you have to set up the upstream. write the following Git command to set up the upstream.

git remote add upstream https://github.com/clubgamma/Weather-Web-App.git

  • Now pull the latest changes from original repo to your local changes by firing the below command > git pull upstream master

  • It's Code Time now

After getting the project in code editor, make necessary changes keeping the features in mind available in readme.

  • Now it's time to save the work

    • Make a branch for the feature you have worked on

      git checkout -b feature_branch_name

    • Stage the changes you have made by firing the below command

      git add .

    • Commit the changes

      git commit -m "Description of changes in your work"

    • Push the changes to your forked repo in that specific feature branch

      git push origin feature_branch_name

    Note: Create a branch for that feature and push there. No direct push to master.

  • Let's finish this

  • Go to your forked repo on GitHub website and refresh the page, you'll see something like the below image Screenshot 2021-09-26 at 6 16 17 PM

  • Click on pull-request and you will be redirected to another page where you will see something like below image

Screenshot 2021-09-26 at 6 16 36 PM

  • After that you have to write your GitHub username as the title of your pull-request and describe your work if you want and that's it!! Create a pull-request by clicking the button Also add the below 2 lines in the description. It is compulsory for successful submission. Screenshot 2021-09-26 at 6 58 08 PM

  • I have read the Code Of Conduct.

  • I have followed all the steps of submission properly.

Woohoo!! Congratulations on making your open source contribution🎉 Wait for some time to get your PR merged by our team