Skip to content

Commit 0adb1c8

Browse files
authored
Merge pull request #7 from gargprince1702/documentation
changed repo abbreviation to full name repository
2 parents 44e10a3 + e36b77c commit 0adb1c8

File tree

1 file changed

+10
-10
lines changed

1 file changed

+10
-10
lines changed

README.md

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,8 +1,8 @@
11
# Simple Static Website
2-
This repository will help the beginners who have just completed the Git course & want to apply there theoretical knowledge.
2+
This repository will help beginners who have just completed the Git course & want to apply their theoretical knowledge.
33

44
# How to contribute
5-
Geeks who are eager to contibute, must read it.
5+
Geeks who are eager to contribute, must read it. 
66

77
## Creating Issues
88

@@ -14,7 +14,7 @@ Geeks who are eager to contibute, must read it.
1414

1515
## Getting Started
1616

17-
1. Goto the [Simple-Static-Website](https://github.com/The-Codesis/simple-static-website/) repo.
17+
1. Goto the [Simple-Static-Website](https://github.com/The-Codesis/simple-static-website/) repository
1818
2. Click on the Fork button in the upper right corner.
1919

2020
Introduce your self to GIT, make sure you use an email associated with your GitHub account.
@@ -23,7 +23,7 @@ git config --global user.name "John Doe"
2323
git config --global user.email [email protected]
2424
```
2525

26-
Make sure you clone the forked repo.
26+
Make sure you clone the forked repository.
2727
```
2828
git clone https://github.com/<your username>/simple-static-website.git
2929
```
@@ -42,11 +42,11 @@ git remote add upstream https://github.com/The-Codesis/simple-static-website.git
4242

4343
When you add a new feature always create an issue first, this allows others to comment and give you tips. It will also help us keep track of what people are adding and with new releases helps us to write new release notes and give you credit for your work.
4444

45-
Secondly always work in a branch, never work on the master branch. Keep your master branch in sync with the master of the official Simple-Static-Website repository. This makes the pull requests (you do want your work to be in the main branch right?) easier for us.
45+
Secondly, always work in a branch, never work on the master branch. Keep your master branch in sync with the master of the official Simple-Static-Website repository. This makes the pull requests (you do want your work to be in the main branch right?) easier for us.
4646

47-
Finally try to keep your branches focused on fixing/adding only one feature and try not fall in the trap of doing a lot of things in a single branch. This will not only make it harder for us to process your pull request but makes it take longer before you can submit your pull request. Small pull requests are more likely to be looked at faster and pulled into the main branch faster.
47+
Finally, try to keep your branches focused on fixing/adding only one feature and try not to fall in the trap of doing a lot of things in a single branch. This will not only make it harder for us to process your pull request but makes it take longer before you can submit your pull request. Small pull requests are more likely to be looked at faster and pulled into the main branch faster.
4848

49-
Here is a simplified workflow on how add a new feature:
49+
Here is a simplified workflow on how to add a new feature:
5050

5151
### Get latest version
5252

@@ -61,19 +61,19 @@ git push
6161

6262
### Create a branch to do your work.
6363

64-
A good practice is to call the branch in the form of GH-<issue-number> followed by the title of the issue. This makes it easier to find out the issue you are trying to solve and helps us to understand what is done in the branch. Calling a branch my-work is confusing. Names of branch can not have a space, and should be replaced with a hyphen.
64+
A good practice is to call the branch in the form of GH-<issue-number> followed by the title of the issue. This makes it easier to find out the issue you are trying to solve and helps us to understand what is done in the branch. Calling a branch my-work is confusing. Names of branch can not have a space, and should be replaced with a hyphen.
6565

6666
```
6767
git checkout -b GH-issuenumber-title-of-issue
6868
```
6969

7070
### Work and commit
7171

72-
Do you work, and commit as you see fit.Make your commit messages helpful.
72+
Do you work, and commit as you see fit. Make your commit messages helpful.
7373

7474
### Push your changes up to GitHub.
7575

76-
If this is the first time pushing to GitHub you will need to extended command, other wise you can simply do a `git push`.
76+
If this is the first time pushing to GitHub you will need to extended command, otherwise, you can simply do a `git push`.
7777

7878
```
7979
git push -u origin GH-issuenumber-title-of-issue

0 commit comments

Comments
 (0)