Skip to content

Commit 966859f

Browse files
authored
Merge pull request #981 from Bushra-gh/main
Fixed typos, grammatical errors and phrasing of some sentences
2 parents d7ac4a7 + f072e8e commit 966859f

10 files changed

Lines changed: 90 additions & 75 deletions

File tree

docs/GitHub/GitHub-basics/create-github-repo.md

Lines changed: 21 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -7,29 +7,33 @@ tags: [GitHub, GitHub-development, document-structure, GitHub repo,]
77
description: In this tutorial, you will learn about the how to create a GitHub repo by Online GUI interface.
88
---
99

10-
In the previous post we spoke about commit, fork, clone, in this post we gonna deep dive into the terminology by creating a GitHub Repository from the Scratch.
11-
Inorder to create a project and host, the repository is a place where you add all your program code files and other documentation.
10+
In the previous post, we learned about commit, fork and clone. In this post, we are going to take a deep dive into the terminology by creating a GitHub Repository from scratch.
11+
To create and host a project, the repository is a place where you add all your program code files and other documentation.
1212

1313
### Prerequisites
1414

15-
- 1. You should have a Github account
16-
- 2. Should have a basic understanding of how Git works/ and Git running in your OS.
15+
- 1. You must have a GitHub account.
16+
- 2. You must also have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
1717

1818
### How to create Github Repository
1919

20-
**Step 1:** Go to GitHub page, by default you will be in the Home page as shown below, Step 1 requires you to click on the ``+`` Icon and from the drop down click on the ``New Repository``.
20+
**Step 1:** Go to the GitHub website. By default, you will be on the Home page as shown below. Click on the ``+`` icon in the top-right corner, and from the dropdown, select ``New Repository``.
2121

2222
<BrowserWindow url="https://github.com" bodyStyle={{padding: 0}}>
2323
[![GitHub](./assets/1-GitHub-repo.png)](https://github.com/sanjay-kv)
2424
</BrowserWindow>
25-
**Step 2:** Specify the name of the Project, make It public or private, for this tutorial you will make it public, Once the repository is gone private the project admin have to give permission or manually added other GitHub user to collaborate or make it visible. This is usual application in the organisation level. The next step check on the readme file, this allows you to create a ``readme.md`` file along with the repository creation. Then click on ``Create repository`` on the button below.
25+
**Step 2:** Specify the name of the project and choose whether to make it public or private. For this tutorial, we’ll make it public.
26+
27+
Once a repository is made private, the project admin must manually grant permission to other GitHub users to collaborate or view it. This is a common practice at the organizational level.
28+
29+
Next, check the box to include a README file—this will automatically create a ``README.md`` file along with the repository. Finally, click on ``Create repository`` at the bottom.
2630

2731

2832
<BrowserWindow url="https://github.com/new" bodyStyle={{padding: 0}}>
2933
[![GitHub](./assets/4-git-gui-install.png)](https://github.com/sanjay-kv)
3034
</BrowserWindow>
3135

32-
Upon creation you will get a screen like this below, the explanation of each elements is mentioned below.
36+
Once the repository is created, you’ll see a screen like the one below. The explanation of each elements is mentioned below.
3337

3438
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo" bodyStyle={{padding: 0}}>
3539
[![GitHub](./assets/5-git-add-file.png)](https://github.com/sanjay-kv)
@@ -44,17 +48,17 @@ Upon creation you will get a screen like this below, the explanation of each ele
4448
- **`<body>`**: Contains the visible content of the document.
4549
- **`<!-- Your content goes here -->`**: Represents a comment that is not displayed in the browser.
4650

47-
## Changing Readme and Adding more files.
51+
## Changing the README and adding more files.
4852

49-
Im going to add my resume and add my name as heading to the ``readme.md`` file
53+
I’m going to add my resume and include my name as a heading in the ``README.md`` file.
5054

5155
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo" bodyStyle={{padding: 0}}>
5256
[![GitHub](./assets/6-edit-file-git.png)](https://github.com/sanjay-kv)
5357
</BrowserWindow>
5458

5559
### Adding Markdown Language
5660

57-
Below is a visual representation of the basic HTML document structure:
61+
Below is a visual representation of a basic HTML document structure:
5862
```html title="readme.md"
5963
# Git-Demo
6064
This is a demo installation via GUI
@@ -66,7 +70,7 @@ This readme contains my resume, please refer to the attached file in the repo.
6670

6771
### Browser Rendering
6872

69-
When the above HTML code is rendered in a browser, it will display the following content:
73+
When the above HTML code is rendered in a browser, it will display the following output:
7074

7175
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo/edit/main/README.md">
7276
<>
@@ -92,13 +96,13 @@ When the above HTML code is rendered in a browser, it will display the following
9296

9397
## Committing the changes.
9498

95-
Im going to add my resume and add my name as heading to the ``readme.md`` file
99+
I'm going to add my resume and include my name as heading to the ``README.md`` file.
96100

97101
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo/edit/main/README.md" bodyStyle={{padding: 0}}>
98102
[![GitHub](./assets/7-commit-the-changes.png)](https://github.com/sanjay-kv)
99103
</BrowserWindow>
100104

101-
Here is the step where they need adding additional comments
105+
This is the step where you need to add additional comments.
102106

103107
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo/edit/main/README.md" bodyStyle={{padding: 0}}>
104108
[![GitHub](./assets/8-commit-message.png)](https://github.com/sanjay-kv)
@@ -112,24 +116,24 @@ https://github.com/sanjay-kv/Git-Demo
112116

113117
### Now let's upload your resume
114118

115-
Im going to add my resume and add my name as heading to the ``readme.md`` file
119+
I'm going to add my resume and include my name as heading to the ``README.md`` file.
116120

117121
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo/edit/main/README.md" bodyStyle={{padding: 0}}>
118122
[![GitHub](./assets/10-add-git-file.png)](https://github.com/sanjay-kv)
119123
</BrowserWindow>
120124

121-
Here is the step where they need adding additional comments
125+
This is the step where you need to add additional comments.
122126

123127
<BrowserWindow url="https://github.com/sanjay-kv/Git-Demo/upload/main" bodyStyle={{padding: 0}}>
124128
[![GitHub](./assets/11-add-file-commit-git.png)](https://github.com/sanjay-kv)
125129
</BrowserWindow>
126130

127-
Now you will be able to see the uploaded resume.
131+
You will now be able to see the uploaded resume in your repository.
128132

129133
### Watch the video Tutorial
130134

131135
<iframe width="880" height="480" src="https://www.youtube.com/embed/XWjx-RjmhRM?list=PLrLTYhoDFx-kiuFiGQqVpYYZ56pIhUW63" title="How to create your first GitHub repository" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
132136

133137
## Conclusion
134138

135-
In this tutorial, you learned about the syntax and structure of HTML. HTML syntax consists of elements, tags, and attributes that define the structure and content of a web page. An HTML document follows a basic structure with elements like `<!DOCTYPE html>`, `<html>`, `<head>`, `<title>`, `<meta>`, and `<body>`. Understanding HTML syntax and structure is essential for creating web pages and applications.
139+
In this tutorial, you learned about the syntax and structure of HTML. HTML syntax consists of elements, tags and attributes that define the structure and content of a web page. A HTML document follows a basic structure with elements like `<!DOCTYPE html>`, `<html>`, `<head>`, `<title>`, `<meta>` and `<body>`. Understanding HTML syntax and structure is essential for creating web pages and applications.

docs/GitHub/GitHub-basics/first-opensource-code.md

Lines changed: 6 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -16,7 +16,7 @@ Welcome to your first open source contribution! In this tutorial, you will learn
1616

1717
## What is Open Source?
1818

19-
Open source software is code that is freely available for anyone to view, use, modify, and distribute. Contributing to open source projects helps you:
19+
Open source software is code that is freely available for anyone to view, use, modify and distribute. Contributing to open source projects helps you:
2020
- Learn from real-world code
2121
- Build your portfolio
2222
- Connect with the developer community
@@ -27,7 +27,7 @@ Open source software is code that is freely available for anyone to view, use, m
2727

2828
Before starting, make sure you have:
2929
- A GitHub account (create one at [github.com](https://github.com))
30-
- Basic understanding of Git and GitHub concepts
30+
- Basic understanding of Git and GitHub concepts.
3131
- Willingness to learn and contribute!
3232

3333
## The Contribution Workflow
@@ -56,7 +56,7 @@ Take a moment to:
5656
- Read the README file to understand the project
5757
- Check if there are contribution guidelines (CONTRIBUTING.md)
5858
- Look at existing issues or pull requests
59-
- Understand what kind of contributions are welcome
59+
- Understand what kind of contributions are welcomed
6060

6161
## Step 2: Fork the Repository
6262

@@ -85,7 +85,7 @@ Once the fork is complete, you'll see:
8585
<div align="center"><small>Step 4: Fork Complete</small></div>
8686
</BrowserWindow>
8787

88-
## Step 3: Edit Files Directly on GitHub
88+
## Step 3: Edit files directly on GitHub
8989

9090
One of the great features of GitHub is the ability to edit files directly in your browser without cloning the repository to your computer.
9191

@@ -126,11 +126,11 @@ Common first contributions include:
126126

127127
:::
128128

129-
## Step 4: Commit Your Changes
129+
## Step 4: Commit your changes
130130

131131
After making your edits, you need to commit them. A commit is like saving a snapshot of your changes with a description.
132132

133-
### Writing a Good Commit Message
133+
### Writing a good commit message
134134

135135
1. Scroll down to the "Commit changes" section
136136
2. Write a clear, concise commit message describing what you changed

docs/GitHub/GitHub-basics/github-repo-command-line.md

Lines changed: 13 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -11,26 +11,27 @@ HTML (Hypertext Markup Language) is the standard markup language for creating we
1111

1212
## Prerequisites
1313

14-
You should have a Github account 2. Should have a basic understanding of how Git works/ and Git running in your OS.
14+
1. You should have a GitHub account.
15+
2. You should have a basic understanding of how Git works and ensure Git is installed and running on your operating system.
1516

1617

1718

1819
### How to create Github Repository
1920

20-
Step 1: Go to Git hub and create a new Repository.
21+
Step 1: Go to GitHub and create a new Repository.
2122

2223
<BrowserWindow url="https://github.com" bodyStyle={{padding: 0}}>
2324
[![GitHub](./assets/1-GitHub-repo.png)](https://github.com/sanjay-kv)
2425
</BrowserWindow>
2526
<br />
2627

27-
Step 2: Specify the Name of the Project, make It public or primate, check on the readme file. Then click on Create repository on the button below.
28+
Step 2: Specify the name of your project, make it public or private, check the option to include a README file. Then click on Create repository on the button below.
2829

2930

3031
<BrowserWindow url="https://github.com/new" bodyStyle={{padding: 0}}>
3132
[![GitHub](./assets/2-repo-create-github.png)](https://github.com/sanjay-kv)
3233
</BrowserWindow>
33-
Upon creation you will get a screen like this below, the explanation of each elements is mentioned below.
34+
Once the repository is created, you'll see a screen similar to the one below, the explanation for each element is provided below.
3435

3536
```html title="create a new repository on the command line"
3637
echo "# demo-repo" >> README.md
@@ -76,7 +77,7 @@ When the above HTML code is rendered in a browser, it will display the following
7677
[![GitHub](./assets/14-git-command-add.png)](https://github.com/sanjay-kv)
7778
</BrowserWindow>
7879

79-
Now you can see the new file been added in your local system
80+
Now you can see the new file has been added to your local system
8081

8182
When the above HTML code is rendered in a browser, it will display the following content:
8283

@@ -88,15 +89,16 @@ When the above HTML code is rendered in a browser, it will display the following
8889

8990
When the above HTML code is rendered in a browser, it will display the following content:
9091
How to push Github Repository?
91-
Step 10: Once the work is done click on save and open cmd/ terminal
92+
Step 10: Once the work is done, click save and open cmd or Terminal
9293

9394
<BrowserWindow url="https://github.com/sanjay-kv/demo-repo" bodyStyle={{padding: 0}}>
9495
[![GitHub](./assets/16-remote-repo.png)](https://github.com/sanjay-kv)
9596
</BrowserWindow>
9697

9798
Step 11: Initially when I was creating the repo I used Git add * to add all files in one go.
9899

99-
If you are committing for the first time adding a file in this way you may ask to enter your GitHub email id and username to proceed. The screenshot will be the same as below. and then while you enter the push command it will ask you browser prompt to sign in to Github.
100+
If you are committing for the first time, Git may prompt you to enter your GitHub email id and username to proceed.
101+
The screenshot below shows an example of the prompt. After entering these details, when you run the git push command, a browser window may open asking you to sign in to GitHub.
100102

101103
```html title="create a new repository on the command line"
102104
git config --global user.email "Enter your github Email"
@@ -112,4 +114,7 @@ git config --global user.name "Github username"
112114

113115
## Conclusion
114116

115-
In this tutorial, you learned about the syntax and structure of HTML. HTML syntax consists of elements, tags, and attributes that define the structure and content of a web page. An HTML document follows a basic structure with elements like `<!DOCTYPE html>`, `<html>`, `<head>`, `<title>`, `<meta>`, and `<body>`. Understanding HTML syntax and structure is essential for creating web pages and applications.
117+
In this tutorial, you learned about the syntax and structure of HTML. HTML syntax consists of elements, tags, and attributes that define the structure and content of a web page.
118+
119+
A HTML document follows a basic structure with elements like `<!DOCTYPE html>`, `<html>`, `<head>`, `<title>`, `<meta>`, and `<body>`.
120+
Understanding HTML syntax and structure is essential for creating web pages and applications.

docs/GitHub/GitHub-basics/index.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@ description: Learn the fundamentals of Git and GitHub — forking, commits, pull
1010

1111
Welcome to the GitHub Basics section. This collection is designed to help beginners get comfortable with Git, GitHub workflows, and making their first open-source contributions.
1212

13-
Whether you're completely new or need a refresher, these guides walk you through practical steps with examples so you can start contributing confidently.
13+
Whether you're completely new or need a refresher, these guides will walk you through practical steps with examples so you can start contributing confidently.
1414

1515
## What you'll learn
1616

0 commit comments

Comments
 (0)