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.

Sign up for GitHub

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

Jump to bottom

Add contributing guide for restructuring tutorial #1794

Merged
merged 2 commits into from
Oct 13, 2024
Merged

Add contributing guide for restructuring tutorial #1794

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
07b9f94
Add contributing guide for restructuring tutorial
amakarudze Apr 18, 2023
0ac55a9
Merge branch 'master' into update-readme-1793
fltfx Oct 11, 2024
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
26 changes: 23 additions & 3 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,7 @@ 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.

## Fork the repository
## Fork the repository {#fork-the-repository}

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

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

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

## New content and complex changes
## New content and complex changes {#new-content-and-complex-changes}

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.

Expand Down Expand Up @@ -132,8 +132,28 @@ Example:
To git@github.com:miohtama/tutorial.git
b37ca59..fe36152 contributing -> contributing

# 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)
# Restructuring the tutorial {#restructuring-the-tutorial}
Restructuring the tutorial is a major change that takes time so we have created a separate branch for these changes.

To make contributions that address issues
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792),
[fork](#fork-the-repository) the repository your repository.

Next you need to follow instructions for [cloning and setting up locally given in the section above](#new-content-and-complex-changes).

Please make use of ["semantic linefeeds"](https://rhodesmill.org/brandon/2012/one-sentence-per-line/) a.k.a.
["semantic line breaks"](https://sembr.org/) for all paragraphs.
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.

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.

All pull requests for changes aimed at restructuring the tutorial which address the issues
[1777](https://github.com/DjangoGirls/tutorial/issues/1777) and [1792](https://github.com/DjangoGirls/tutorial/issues/1792)
should be made to the `restructure-tutorial`.

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.

# Making a pull request {#making-a-pull-request}
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.

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