You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
{{ message }}
This repository was archived by the owner on Jun 26, 2022. It is now read-only.
Copy file name to clipboardExpand all lines: README.md
+24-20
Original file line number
Diff line number
Diff line change
@@ -6,24 +6,23 @@
6
6
7
7
## Instructions:
8
8
9
-
*Make sure you have a GitHub account. In case you don't have one, you can create your account by visiting https://github.com/ and clicking on ``Sign up`` option at the top right corner.*
10
-
9
+
_Make sure you have a GitHub account. In case you don't have one, you can create your account by visiting https://github.com/ and clicking on `Sign up` option at the top right corner._
11
10
12
11
### 1. Star and Fork this Repository
12
+
13
13
###### You can star and fork this repository on GitHub by navigating at the top of this repository.
14
14
15
15
GitHub repository URLs will reference both the username associated with the owner of the repository, as well as the repository name. For example, acmbvp is the owner of the Hacktoberfest repository, so the GitHub URL for this project is:
16
16
17
17
https://github.com/SanjayDevTech/Code-with-love
18
18
19
-
20
19
When you’re on the main page of a repository, you’ll see a button to "Star" and “Fork” the repository on the upper right-hand side of the page, underneath your user icon.
21
20
22
21
### 2. Clone the Repository
23
22
24
23
To make your own local copy of the repository you would like to contribute to, let’s first open up a terminal window.
25
24
26
-
We’ll use the `git clone`command along with the URL that points to your fork of the repository.
25
+
We’ll use the `git clone` command along with the URL that points to your fork of the repository.
27
26
28
27
This URL will be similar to the URL above, except now it will end with `.git.` The URL will look like this:
To create your branch, from your terminal window, change your directory so that you are working in the directory of the repository. Be sure to use the actual name of the repository (i.e. Code-with-love) to switch into that directory.
41
39
42
-
##### `cd Code-with-love`
40
+
##### `cd Code-with-love`
43
41
44
42
Now, we’ll create our new branch with the git branch command. Make sure you name it descriptively so that others working on the project understand what you are working on.
45
43
46
44
##### `git branch new-branch`
47
45
48
46
Now that our new branch is created, we can switch to make sure that we are working on that branch by using the git checkout command:
49
47
50
-
##### `git checkout new-branch`
48
+
##### `git checkout new-branch`
51
49
52
50
Once you enter the git `checkout` command, you will receive the following output:
53
51
54
-
###### `Output:`
55
-
##### `Switched to branch 'new-branch' `
52
+
###### `Output:`
53
+
54
+
##### `Switched to branch 'new-branch' `
56
55
56
+
##### `code .`
57
+
58
+
Once you enter this command, the whole code will automatically open in your code editor
57
59
58
60
At this point, you can now modify existing files or add new files to the project on your own branch.
59
61
60
62
#### Make Changes Locally
61
63
62
64
Once you have modified existing files or added new files to the project, you can add them to your local repository, which you can do with the git add command. Let’s add the -A flag to add all changes that we have made:
63
65
64
-
##### `git add -A` or `git add .`
66
+
##### `git add -A` or `git add .`
65
67
66
68
Next, we’ll want to record the changes that we made to the repository with the git commit command.
67
69
68
-
*The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. Additionally, commit messages provide a historical record of the changes for the project at large, helping future contributors along the way.*
69
-
70
+
_The commit message is an important aspect of your code contribution; it helps the other contributors fully understand the change you have made, why you made it, and how significant it is. Additionally, commit messages provide a historical record of the changes for the project at large, helping future contributors along the way._
70
71
71
72
If you have a very short message, you can record that with the -m flag and the message in quotes:
72
73
73
-
###### ` Example: `
74
-
##### ` git commit -m "Updated Readme.md" `
74
+
###### `Example:`
75
+
76
+
##### `git commit -m "Updated Readme.md"`
75
77
76
78
###### At this point you can use the git push command to push the changes to the current branch of your forked repository:
*While working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don’t want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you’ll need to sync changes.*
86
+
_While working on a project alongside other contributors, it is important for you to keep your local repository up-to-date with the project as you don’t want to make a pull request for code that will cause conflicts. To keep your local copy of the code base updated, you’ll need to sync changes._
83
87
84
88
We’ll first go over configuring a remote for the fork, then syncing the fork.
85
89
86
90
### 5. Configure a Remote for the Fork
87
91
88
92
Next up, you’ll have to specify a new remote upstream repository for us to sync with the fork. This will be the original repository that you forked from. you’ll have to do this with the git remote add command.
In this example, // upstream // is the shortname we have supplied for the remote repository since in terms of Git, “upstream” refers to the repository that you cloned from. If you want to add a remote pointer to the repository of a collaborator, you may want to provide that collaborator’s username or a shortened nickname for the shortname.
93
97
@@ -96,15 +100,15 @@ In this example, // upstream // is the shortname we have supplied for the remote
96
100
Once you have configured a remote that references the upstream and original repository on GitHub, you are ready to sync your fork of the repository to keep it up-to-date.
97
101
To sync your fork, from the directory of your local repository in a terminal window, you’ll have to use the // git fetch // command to fetch the branches along with their respective commits from the upstream repository. Since you used the shortname “upstream” to refer to the upstream repository, you’ll have to pass that to the command:
98
102
99
-
##### `git fetch upstream`
103
+
##### `git fetch upstream`
100
104
101
105
Switch to the local master branch of our repository:
102
106
103
-
##### `git checkout master`
107
+
##### `git checkout master`
104
108
105
109
Now merge any changes that were made in the original repository’s master branch, that you will access through your local upstream/master branch, with your local master branch:
0 commit comments