|
| 1 | +## Steps to follow : |
| 2 | + |
| 3 | +### 1. Fork it : |
| 4 | + |
| 5 | +You can get your own fork/copy of [internship](https://github.com/coderplex/internship) by using the <a href="https://github.com/coderplex/internship"><kbd><b>Fork</b></kbd></a> button . |
| 6 | + |
| 7 | +[](https://github.com/coderplex/internship) |
| 8 | + |
| 9 | +### 2. Clone it : |
| 10 | + |
| 11 | +You need to clone (download) it to local machine using |
| 12 | + |
| 13 | +``` |
| 14 | +$ git clone https://github.com/Your_Username/internship.git |
| 15 | +``` |
| 16 | + |
| 17 | +> This makes a local copy of repository in your machine. |
| 18 | +
|
| 19 | +Once you have cloned the `internship` repository in Github, move to that folder first using change directory command. |
| 20 | + |
| 21 | +```sh |
| 22 | +# This will change directory to a folder internship |
| 23 | +$ cd internship |
| 24 | +``` |
| 25 | + |
| 26 | +Move to this folder for all other commands. |
| 27 | + |
| 28 | +### 3. Set it up : |
| 29 | + |
| 30 | +Run the following commands to see that *your local copy* has a reference to *your forked remote repository* in Github : |
| 31 | + |
| 32 | +```sh |
| 33 | +$ git remote -v |
| 34 | +origin https://github.com/Your_Username/internship.git (fetch) |
| 35 | +origin https://github.com/Your_Username/internship.git (push) |
| 36 | +``` |
| 37 | + |
| 38 | +Now, lets add a reference to the original [internship](https://github.com/coderplex/internship) repository using |
| 39 | + |
| 40 | +```sh |
| 41 | +$ git remote add upstream https://github.com/coderplex/internship.git |
| 42 | +``` |
| 43 | + |
| 44 | +> This adds a new remote named ***upstream***. |
| 45 | +
|
| 46 | +See the changes using |
| 47 | + |
| 48 | +```sh |
| 49 | +$ git remote -v |
| 50 | +origin https://github.com/Your_Username/internship.git (fetch) |
| 51 | +origin https://github.com/Your_Username/internship.git (push) |
| 52 | +upstream https://github.com/coderplex/internship.git (fetch) |
| 53 | +upstream https://github.com/coderplex/internship.git (push) |
| 54 | +``` |
| 55 | + |
| 56 | +### 4. Sync it : |
| 57 | + |
| 58 | +Always keep your local copy of repository updated with the original repository. |
| 59 | +Before making any changes and/or in an appropriate interval, run the following commands *carefully* to update your local repository. |
| 60 | + |
| 61 | +```sh |
| 62 | +# Fetch all remote repositories and delete any deleted remote branches |
| 63 | +$ git fetch --all --prune |
| 64 | + |
| 65 | +# Switch to `master` branch |
| 66 | +$ git checkout master |
| 67 | + |
| 68 | +# Reset local `master` branch to match `upstream` repository's `master` branch |
| 69 | +$ git reset --hard upstream/master |
| 70 | + |
| 71 | +# Push changes to your forked `internship` repo |
| 72 | +$ git push origin master |
| 73 | +``` |
| 74 | + |
| 75 | +Once you have completed these steps, you are ready to start contributing by checking our `Help Wanted` Issues and creating [pull requests](https://github.com/coderplex/internship/pulls) . |
| 76 | + |
| 77 | +### 5. Create a new branch : |
| 78 | + |
| 79 | +Whenever you are going to make contribution. Please create seperate branch using command and keep your `master` branch clean (i.e. synced with remote branch). |
| 80 | + |
| 81 | +```sh |
| 82 | +# It will create a new branch with name Branch_Name and switch to branch Folder_Name |
| 83 | +$ git checkout -b Folder_Name |
| 84 | +``` |
| 85 | + |
| 86 | +Create a seperate branch for contibution and try to use same name of branch as of folder. |
| 87 | + |
| 88 | +To switch to a desired branch |
| 89 | + |
| 90 | +```sh |
| 91 | +# To switch from one folder to other |
| 92 | +$ git checkout Folder_Name |
| 93 | +``` |
| 94 | + |
| 95 | +To add the changes to the branch, use |
| 96 | + |
| 97 | +```sh |
| 98 | +# To add all files to branch Folder_Name |
| 99 | +$ git add . |
| 100 | +``` |
| 101 | + |
| 102 | +Type in a message relevant for the code reveiwer using |
| 103 | + |
| 104 | +```sh |
| 105 | +# This message gets associated with all files you have changed |
| 106 | +$ git commit -m 'relevant message' |
| 107 | +``` |
| 108 | + |
| 109 | +Now, Push your awesome work to your remote repository using |
| 110 | + |
| 111 | +```sh |
| 112 | +# To push your work to your remote repository |
| 113 | +$ git push -u origin Folder_Name |
| 114 | +``` |
| 115 | + |
| 116 | +Finally, go to your repository in browser and click on `compare and pull requests`. |
| 117 | +Then add a title and description to your pull request that explains your efforts. |
| 118 | + |
| 119 | +## To contribute to the [Learnplex Project](https://github.com/coderplex/learnplex) , please refer to the Prerequisites and Installation section of [Learnplex Docs](https://docs.coderplex.in/) . |
0 commit comments