Skip to content

Commit 07b9f94

Browse files
committed
Add contributing guide for restructuring tutorial
1 parent bda18f2 commit 07b9f94

File tree

1 file changed

+24
-3
lines changed

1 file changed

+24
-3
lines changed

README.md

Lines changed: 24 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ For contributing to the tutorial the following is needed to get started:
2626
* a [GitHub account](https://github.com)
2727
* 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.
2828

29-
## Fork the repository
29+
## Fork the repository {#fork-the-repository}
3030

3131
First fork the [DjangoGirls/tutorial](https://github.com/DjangoGirls/tutorial) repository to your personal GitHub account:
3232

@@ -60,7 +60,7 @@ Markdown syntax is used to edit the individual pages of the tutorial.
6060

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

63-
## New content and complex changes
63+
## New content and complex changes {#new-content-and-complex-changes}
6464

6565
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.
6666

@@ -114,7 +114,28 @@ Example:
114114
To git@github.com:miohtama/tutorial.git
115115
b37ca59..fe36152 contributing -> contributing
116116

117-
# Making a pull request
117+
# Restructuring the tutorial {#restructuring-the-tutorial}
118+
Restructuring the tutorial is a major change that takes time so we have created a separate branch for these changes.
119+
120+
To make contributions that address issues
121+
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792),
122+
[fork](#fork-the-repository) the repository your repository.
123+
124+
Next you need to follow instructions for [cloning and setting up locally given in the section above](#new-content-and-complex-changes).
125+
126+
Please make use of ["semantic linefeeds"](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) a.k.a.
127+
["semantic line breaks"](https://sembr.org/) for all paragraphs.
128+
Though most of the Django Girls tutorial wasn't originally written that way, placing source line breaks at semantically meaningful spots in the text (and especially between sentences) facilitates both, commenting on individual statements or thoughts in the text as part of the review process, as well as future editing and diff-ing.
129+
130+
As we restructure the tutorial, this would be a great change to introduce to the tutorial so please make sure the chapter you work on follow this pattern.
131+
132+
All pull requests for changes aimed at restructuring the tutorial which address the issues
133+
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792)
134+
should be made to the `restructure-tutorial`.
135+
136+
All other steps for creating a pull request are the same as those outlined in the section on [making a pull request below](#making-a-pull-request), just make sure you make the pull request against the `restructure-tutorial` branch.
137+
138+
# Making a pull request {#making-a-pull-request}
118139

119140
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.
120141

0 commit comments

Comments
 (0)