Skip to content

Commit

Permalink
Merge pull request #1802 from elena/master
Browse files Browse the repository at this point in the history
Update README add Quickstart
  • Loading branch information
elena authored Oct 5, 2023
2 parents 7e9ba93 + 68cb21a commit 577401f
Showing 1 changed file with 21 additions and 3 deletions.
24 changes: 21 additions & 3 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,25 @@
# Django Girls Tutorial

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

**NOT** intended for reading here. To read go to: [📖 tutorial.djangogirls.org 📖](http://tutorial.djangogirls.org)

# Contribution QUICKSTART

1. Fork this repo [[fork](#fork-the-repository)]

> 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)!
2. **[Big changes](#new-content-and-complex-changes)**: clone your fork locally.
3. [CLI](#cli-for-development) run `make dev` in repo.

```
$ make dev
...
Serving book on http://localhost:4000
```

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).

# How to contribute

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

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

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

0 comments on commit 577401f

Please sign in to comment.