aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/02_Github.md
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2021-03-15 00:00:25 +0100
committerGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2021-03-15 00:00:25 +0100
commit1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch)
tree5b3a9df3cc709a4b370f6f03cf79c50483275344 /docs/en/developers/02_Github.md
parent769f34e958b50e748acf6a151805f4a255df2043 (diff)
Quick update the doc for master renaming to edge
Diffstat (limited to 'docs/en/developers/02_Github.md')
-rw-r--r--docs/en/developers/02_Github.md22
1 files changed, 14 insertions, 8 deletions
diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md
index 953785d4f..7a7769caa 100644
--- a/docs/en/developers/02_Github.md
+++ b/docs/en/developers/02_Github.md
@@ -1,6 +1,7 @@
# Branching
## Basic
+
If you are new to Git, here are some of the resources you might find useful:
* [GitHub's blog post](https://github.com/blog/120-new-to-git)
@@ -9,30 +10,35 @@ If you are new to Git, here are some of the resources you might find useful:
* <http://rogerdudler.github.io/git-guide/>
## Getting the latest code from the FreshRSS repository
+
First you need to add the official repo to your remote repo list:
-```bash
+
+```sh
git remote add upstream git@github.com:FreshRSS/FreshRSS.git
```
You can verify the remote repo is successfully added by using:
-```bash
+
+```sh
git remote -v show
```
Now you can pull the latest development code:
-```bash
-git checkout master
-git pull upstream master
+
+```sh
+git checkout edge
+git pull upstream edge
```
## Starting a new development branch
-```bash
+
+```sh
git checkout -b my-development-branch
```
-# Sending a patch
+## Sending a patch
-```bash
+```sh
# Add the changed file, here actualize_script.php
git add app/actualize_script.php
# Commit the change and write a proper commit message