Skip to content

Commit 7a9144e

Browse files
thefonthefon
committed
Updates README.md
Auto commit by GitBook Editor
1 parent 36b2c48 commit 7a9144e

1 file changed

Lines changed: 39 additions & 33 deletions

File tree

‎README.md‎

Lines changed: 39 additions & 33 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,10 @@
1-
# Django Girls Tutorial
1+
# BHP Django Girls Tutorial
22

33
This is the source code repository for the Django Girls Tutorial. Django Girls Tutorial is used on [tutorial.djangogirls.org](http://tutorial.djangogirls.org) so if you want to read it, please go there. If you want to contribute please do go further with this file.
44

5-
65
# How to contribute
76

8-
The Django Girls Tutorial is licensed under a [*Creative Commons Attribution-ShareAlike 4.0*](https://creativecommons.org/licenses/by-sa/4.0/) license. Everyone is free to add, edit and correct the tutorial.
7+
The Django Girls Tutorial is licensed under a [_Creative Commons Attribution-ShareAlike 4.0_](https://creativecommons.org/licenses/by-sa/4.0/) license. Everyone is free to add, edit and correct the tutorial.
98

109
# Editing basics
1110

@@ -24,7 +23,7 @@ You can find any discussions about the contents of the tutorial on the [Github i
2423
For contributing to the tutorial the following is needed to get started:
2524

2625
* a [Github account](https://github.com)
27-
* in the case of complex edits familiarity with [Git command line basics](https://help.github.com/articles/set-up-git) or familiarity with an app ([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)) to push your edits made on your computer to Github.
26+
* in the case of complex edits familiarity with [Git command line basics](https://help.github.com/articles/set-up-git) or familiarity with an app \([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)\) to push your edits made on your computer to Github.
2827

2928
## Fork the repository
3029

@@ -39,8 +38,8 @@ First fork the [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) r
3938
For simple changes like typo corrections you can use the Github online editor:
4039

4140
* Open your local fork page on Github,
42-
* go to *README.md* file in any chapter,
43-
* press the *Edit* icon (pen)
41+
* go to _README.md_ file in any chapter,
42+
* press the _Edit_ icon \(pen\)
4443

4544
and you can edit the chapter directly on github.com.
4645

@@ -56,60 +55,66 @@ Save your changes and create a pull request as explained below.
5655

5756
For adding new chapters, writing longer snippets of text or adding images, you need to get a copy of the tutorial to your local computer.
5857

59-
Either use the Github app for your operating system (mentioned above) or `git` command line to get the repository locally. You get the repository address from the front page of your own Github repository fork:
58+
Either use the Github app for your operating system \(mentioned above\) or `git` command line to get the repository locally. You get the repository address from the front page of your own Github repository fork:
6059

61-
git clone [email protected]:yourgithubusername/tutorial.git
60+
```
61+
git clone [email protected]:yourgithubusername/tutorial.git
62+
```
6263

6364
Then, create a branch for your new changes to sit in. It helps to call the branch something related to the changes you are going to make.
6465

65-
git checkout -b contributing
66+
```
67+
git checkout -b contributing
68+
```
6669

6770
Download the [Gitbook Editor](https://www.gitbook.com/editor) app to your computer.
6871

69-
Then you can open the tutorial in Gitbook Editor (*File* > *Open book*).
72+
Then you can open the tutorial in Gitbook Editor \(_File_ > _Open book_\).
7073

71-
Make any changes in the tutorial using Gitbook and then save changes (*Book* > *Save all*).
74+
Make any changes in the tutorial using Gitbook and then save changes \(_Book_ > _Save all_\).
7275

7376
Then commit the changes using `git` and push the changes to your remote Github repository.
7477

7578
Example:
7679

77-
$ git status
78-
On branch contributing
79-
Untracked files:
80-
(use "git add <file>..." to include in what will be committed)
80+
```
81+
$ git status
82+
On branch contributing
83+
Untracked files:
84+
(use "git add <file>..." to include in what will be committed)
8185
82-
contributing_and_editing_this_book/images/gitbook.png
86+
contributing_and_editing_this_book/images/gitbook.png
8387
84-
$ git add contributing_and_editing_this_book/images/gitbook.png
88+
$ git add contributing_and_editing_this_book/images/gitbook.png
8589
86-
$ git commit -m "Added gitbook editor screenshot"
87-
[contributing fe36152] Added gitbook screenshot
88-
1 file changed, 0 insertions(+), 0 deletions(-)
89-
create mode 100644 contributing_and_editing_this_book/images/gitbook.png
90+
$ git commit -m "Added gitbook editor screenshot"
91+
[contributing fe36152] Added gitbook screenshot
92+
1 file changed, 0 insertions(+), 0 deletions(-)
93+
create mode 100644 contributing_and_editing_this_book/images/gitbook.png
9094
91-
$ git push
92-
Counting objects: 11, done.
93-
Delta compression using up to 8 threads.
94-
Compressing objects: 100% (5/5), done.
95-
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
96-
Total 5 (delta 1), reused 0 (delta 0)
97-
To [email protected]:miohtama/tutorial.git
98-
b37ca59..fe36152 contributing -> contributing
95+
$ git push
96+
Counting objects: 11, done.
97+
Delta compression using up to 8 threads.
98+
Compressing objects: 100% (5/5), done.
99+
Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.
100+
Total 5 (delta 1), reused 0 (delta 0)
101+
To [email protected]:miohtama/tutorial.git
102+
b37ca59..fe36152 contributing -> contributing
103+
```
99104

100105
If you don't want to download the Gitbook Editor app you can also go to the [Gitbook website](https://www.gitbook.com/), sign up for free and work directly in your browser.
101106

102107
# Making a pull request
103108

104-
After you have finished your changes you need to create [a pull request](https://help.github.com/articles/using-pull-requests) on Github. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then *pull* your changes to the master version.
109+
After you have finished your changes you need to create [a pull request](https://help.github.com/articles/using-pull-requests) on Github. DjangoGirls will get notified about the pull request, review your changes, suggest any corrections if needed and then _pull_ your changes to the master version.
105110

106-
In your own repository on Github press do *Compare & pull request*
111+
In your own repository on Github press do _Compare & pull request_
107112

108113
![Gitbook](contributing/images/pull_request.png)
109114

110-
Fill in the information *why* this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.
115+
Fill in the information _why_ this change is being made. The reviewer can see the details of the actual change, so you don't need repeat the content of the change.
111116

112-
Then press *Create pull request*.
117+
Then press _Create pull request_.
113118

114119
Github emails will notify you for the follow up process.
115120

@@ -118,3 +123,4 @@ Github emails will notify you for the follow up process.
118123
GitHub has an excellent [documentation](https://help.github.com/). Check it out if you need help!
119124

120125
For further questions please [contact DjangoGirls](https://djangogirls.org/).
126+

0 commit comments

Comments
 (0)