Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Contributing chapter added #45

Merged
merged 5 commits into from
Jul 26, 2014
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,7 @@ It will (more or less) look like this:
![Figure 0.1](images/application.png)

Ok, let's start at the beginning...

## About and contributing

This tutorial is maintained by [DjangoGirls](http://djangogirls.org/). If you find any mistakes or want to update the tutorial please [follow the contributing guidelines](contributing/README.md).
1 change: 1 addition & 0 deletions SUMMARY.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,4 +22,5 @@
* [Django Forms](django_forms/README.md)
* [Domain](domain/README.md)
* [Homework: add more to your website!](homework/README.md)
* [Contributing and editing](contributing_and_editing_this_book/README.md)

106 changes: 106 additions & 0 deletions contributing_and_editing_this_book/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,106 @@
# How to contribute

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

# Editing basics

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

The tutorial uses [GitBook](https://www.gitbook.io/) service for the publishing the documentation. [See more information about how Gitbook works](http://help.gitbook.io/).

The tutorial is written in [Markdown mark up language](https://help.github.com/articles/markdown-basics).

You can find any discussion about the content of the tutorial on [Github issue tracker](https://github.com/DjangoGirls/tutorial/issues).

# Getting started and prerequisites

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

* You have a [Github account](https://github.com)
* For complex changes you need to be familiar with [Git command line basics](https://help.github.com/articles/set-up-git) or you are using an app ([Windows](https://windows.github.com/), [Mac](https://mac.github.com/)) to push your edits on a local computer to Github

## Fork the repository

First fork [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) project into your personal Github repository:

![Fork button](images/fork.png)

# Editing chapter content

## Simple changes

For a simple changes like typo corrections you can use Github online editor.

* Open your local fork page on Github
* Go to *README.md* file in any chapter
* Press *Edit* icon (pen) and you can edit the chapter in Github's online editor

![Edit button](images/edit.png)

Now you can edit the page in Markdown syntax.

![Github editor](images/github_editor.png)

Save changes and make a pull request as explained below.

## New content and complex changes

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

Either use Github app (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 git@github.com:yourgithubusername/tutorial.git

Download [Gitbook Editor](http://help.gitbook.io/editor/README.html) app to your computer.

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

![Gitbook](images/gitbook.png)

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

Then commin 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 git@github.com:miohtama/tutorial.git
b37ca59..fe36152 contributing -> contributing

# Making a pull request

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*

![Gitbook](images/pull_request.png)

Fill in the information *why* this change is being made. The reviewer can see the details of 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.

# Further information and help

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

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.