Skip to content

Commit 577401f

Browse files
authored
Merge pull request #1802 from elena/master
Update README add Quickstart
2 parents 7e9ba93 + 68cb21a commit 577401f

File tree

1 file changed

+21
-3
lines changed

1 file changed

+21
-3
lines changed

README.md

Lines changed: 21 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
# Django Girls Tutorial
22

3-
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.
3+
~ 🖥 Source Code 🖥 ~
44

5+
**NOT** intended for reading here. To read go to: [📖 tutorial.djangogirls.org 📖](http://tutorial.djangogirls.org)
6+
7+
# Contribution QUICKSTART
8+
9+
1. Fork this repo [[fork](#fork-the-repository)]
10+
11+
> 2. **[Small changes](#simple-changes)**: you can now edit your fork on the github website, do this! Make a change, then [create a pull request](#making-a-pull-request)!
12+
13+
2. **[Big changes](#new-content-and-complex-changes)**: clone your fork locally.
14+
3. [CLI](#cli-for-development) run `make dev` in repo.
15+
16+
```
17+
$ make dev
18+
...
19+
Serving book on http://localhost:4000
20+
```
21+
22+
Note: we have many changes under way we maybe working on your request already! Refer to existing [Pull requests](https://github.com/DjangoGirls/tutorial/pulls).
523

624
# How to contribute
725

@@ -114,9 +132,9 @@ Example:
114132
To git@github.com:miohtama/tutorial.git
115133
b37ca59..fe36152 contributing -> contributing
116134

117-
# Making a pull request
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)
118136

119-
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.
137+
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.
120138

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

0 commit comments

Comments
 (0)