Skip to content

Commit 04c70d6

Browse files
authored
Merge pull request #1794 from amakarudze/update-readme-1793
Add contributing guide for restructuring tutorial
2 parents 15b70fa + 0ac55a9 commit 04c70d6

File tree

1 file changed

+23
-3
lines changed

1 file changed

+23
-3
lines changed

README.md

+23-3
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ For contributing to the tutorial the following is needed to get started:
4444
* a [GitHub account](https://github.com)
4545
* 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.
4646

47-
## Fork the repository
47+
## Fork the repository {#fork-the-repository}
4848

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

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

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

81-
## New content and complex changes
81+
## New content and complex changes {#new-content-and-complex-changes}
8282

8383
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.
8484

@@ -132,8 +132,28 @@ Example:
132132
To [email protected]:miohtama/tutorial.git
133133
b37ca59..fe36152 contributing -> contributing
134134

135-
# Making a [pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/about-pull-requests)
135+
# Restructuring the tutorial {#restructuring-the-tutorial}
136+
Restructuring the tutorial is a major change that takes time so we have created a separate branch for these changes.
136137

138+
To make contributions that address issues
139+
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792),
140+
[fork](#fork-the-repository) the repository your repository.
141+
142+
Next you need to follow instructions for [cloning and setting up locally given in the section above](#new-content-and-complex-changes).
143+
144+
Please make use of ["semantic linefeeds"](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) a.k.a.
145+
["semantic line breaks"](https://sembr.org/) for all paragraphs.
146+
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.
147+
148+
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.
149+
150+
All pull requests for changes aimed at restructuring the tutorial which address the issues
151+
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792)
152+
should be made to the `restructure-tutorial`.
153+
154+
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.
155+
156+
# Making a pull request {#making-a-pull-request}
137157
After you have finished your changes you need to [create a pull request](https://docs.github.com/en/pull-requests/collaborating-with-pull-requests/proposing-changes-to-your-work-with-pull-requests/creating-a-pull-request) 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.
138158

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

0 commit comments

Comments
 (0)