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.

The Django Girls Tutorial is licensed under a *Creative Commons Attribution-ShareAlike 4.0* license. Everyone is free to add, edit and correct the tutorial.

The source code of the tutorial is [hosted on Github](http://github.com/DjangoGirls/tutorial). The Github [Fork & Pull workflow](https://help.github.com/articles/using-pull-requests) is used to accept and review changes.

For contributing to the tutorial the following is needed to get started:

* a [Github account](https://github.com)

* 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.

For simple changes like typo corrections you can use the Github online editor:

* Open your local fork page on Github,

* go to *README.md* file in any chapter,

* press the *Edit* icon (pen)

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


Markdown syntax is used to edit the individual pages of the tutorial.


Save your changes and create a pull request as explained below.

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.

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:

git clone [email protected]:yourgithubusername/tutorial.git

Download the [Gitbook Editor](https://github.com/GitbookIO/editor/releases) app to your computer.

Then you can open the tutorial in Gitbook Editor (*File* > *Open book*).

Make any changes in the tutorial using Gitbook and then save changes (*Book* > *Save all*).

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

Example:

$ git status

On branch contributing

Untracked files:

(use "git add <file>..." to include in what will be committed)

contributing_and_editing_this_book/images/gitbook.png

$ git add contributing_and_editing_this_book/images/gitbook.png

$ git commit -m "Added gitbook editor screenshot"

[contributing fe36152] Added gitbook screenshot

1 file changed, 0 insertions(+), 0 deletions(-)

create mode 100644 contributing_and_editing_this_book/images/gitbook.png

$ git push

Counting objects: 11, done.

Delta compression using up to 8 threads.

Compressing objects: 100% (5/5), done.

Writing objects: 100% (5/5), 266.37 KiB | 0 bytes/s, done.

Total 5 (delta 1), reused 0 (delta 0)

To [email protected]:miohtama/tutorial.git

b37ca59..fe36152 contributing -> contributing

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

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.

In your own repository on Github press do *Compare & pull request*


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.

Then press *Create pull request*.

Github emails will notify you for the follow up process.

GitHub has an excellent [documentation](https://help.github.com/). Check it out if you need help!

For further questions please [contact DjangoGirls](http://djangogirls.org/).