Skip to content

Latest commit

 

History

History
119 lines (80 loc) · 3.49 KB

ContributingGuidelines.md

File metadata and controls

119 lines (80 loc) · 3.49 KB
Raw

Steps to follow :

1. Fork it :

You can get your own fork/copy of this repo by using the Fork button .

Fork Button

2. Clone it :

You need to clone (download) it to local machine using

$ git clone https://github.com/Your_Username/menu-page.git

This makes a local copy of repository in your machine.

Once you have cloned the menu-page repository in Github, move to that folder first using change directory command.

# This will change directory to a folder menu-page
$ cd internship

Move to this folder for all other commands.

3. Set it up :

Run the following commands to see that your local copy has a reference to your forked remote repository in Github :

$ git remote -v
origin  https://github.com/Your_Username/menu-page.git (fetch)
origin  https://github.com/Your_Username/menu-page.git (push)

Now, lets add a reference to the original menu-page repository using

$ git remote add upstream https://github.com/m-code12/menu-page.git

This adds a new remote named upstream.

See the changes using

$ git remote -v
origin    https://github.com/Your_Username/menu-page.git (fetch)
origin    https://github.com/Your_Username/menu-page.git (push)
upstream  https://github.com/m-code12/menu-page.git (fetch)
upstream  https://github.com/m-code12/menu-page.git (push)

4. Sync it :

Always keep your local copy of repository updated with the original repository. Before making any changes and/or in an appropriate interval, run the following commands carefully to update your local repository.

# Fetch all remote repositories and delete any deleted remote branches
$ git fetch --all --prune

# Switch to `master` branch
$ git checkout master

# Reset local `master` branch to match `upstream` repository's `master` branch
$ git reset --hard upstream/master

# Push changes to your forked `menu-page` repo
$ git push origin master

Once you have completed these steps, you are ready to start contributing by checking our Help Wanted Issues and creating pull requests .

5. Create a new branch :

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).

# It will create a new branch with name Branch_Name and switch to branch Folder_Name
$ git checkout -b Folder_Name

Create a seperate branch for contibution and try to use same name of branch as of folder.

To switch to a desired branch

# To switch from one folder to other
$ git checkout Folder_Name

To add the changes to the branch, use

# To add all files to branch Folder_Name
$ git add .

Type in a message relevant for the code reveiwer using

# This message gets associated with all files you have changed
$ git commit -m 'relevant message'

Now, Push your awesome work to your remote repository using

# To push your work to your remote repository
$ git push -u origin Folder_Name

Finally, go to your repository in browser and click on compare and pull requests. Then add a title and description to your pull request that explains your efforts.

Congratulations you have successfully made your first contribution in this repo 🎉🚀.