Skip to content

Latest commit

 

History

History
78 lines (70 loc) · 3.61 KB

README.md

File metadata and controls

78 lines (70 loc) · 3.61 KB
Raw

Welcome to IPU-Engineering-Notes

Our open source community helps in gathering notes for students studying in GGSIPU, or whenever someone gets confused, they can refer to the notes or study materials . So, we are developing a repository and trying to implement it for all semesters .

Steps to follow 📜

1. Fork it 🍴

You can get your own fork/copy of ipu-engineering-notes by using the Fork button or clicking this. Fork Button

2. Clone it 👥

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

$ git clone https://github.com/Your_Username/ipu-engineering-notes.git

This makes a local copy of repository in your machine. Once you have cloned the ipu-engineering-notes repository in Github, move to that folder first using change directory command on linux and Mac.

# This will change directory to a folder IPU-Engineering-Notes
$ cd ipu-engineering-notes

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 :octocat:

$ git remote -v
origin  https://github.com/Your_Username/ipu-engineering-notes.git (fetch)
origin  https://github.com/Your_Username/ipu-engineering-notes.git (push)

Now, lets add a reference to the original ipu-engineering-notes repository using

$ git remote add upstream https://github.com/Coderjolly/IPU-Engineering-Notes.git

This adds a new remote named upstream. See the changes using

$ git remote -v
origin    https://github.com/Your_Username/ipu-engineering-notes.git (fetch)
origin    https://github.com/Your_Username/ipu-engineering-notes.git (push)
upstream  https://github.com/coderjolly/ipu-engineering-notes.git (fetch)
upstream  https://github.com/coderjolly/ipu-engineering-notes.git (push)

4. Ready Steady Go... 🐢 🐇

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 separate 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 separate branch for contribution and try to use same name of branch as of folder. To switch to 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 reviewer using

# This message get 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 precious effort.**