aboutsummaryrefslogtreecommitdiff
path: root/docs/en/developers/02_GitHub.md
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2024-05-15 08:58:10 +0200
committerGravatar GitHub <noreply@github.com> 2024-05-15 08:58:10 +0200
commit2ed91026fcfef83ce5ef466a15e078229a106a6f (patch)
treee11f2ef5f85d65029c9bdcc6d38304d8cbcdada6 /docs/en/developers/02_GitHub.md
parent2d17c020b6695d47debda065804db4e2d2f92e55 (diff)
Correct casing for GitHub (#6460)
Diffstat (limited to 'docs/en/developers/02_GitHub.md')
-rw-r--r--docs/en/developers/02_GitHub.md62
1 files changed, 62 insertions, 0 deletions
diff --git a/docs/en/developers/02_GitHub.md b/docs/en/developers/02_GitHub.md
new file mode 100644
index 000000000..066d6ffb0
--- /dev/null
+++ b/docs/en/developers/02_GitHub.md
@@ -0,0 +1,62 @@
+# 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)
+* <http://try.github.com/>
+* <http://sixrevisions.com/resources/git-tutorials-beginners/>
+* <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:
+
+```sh
+git remote add upstream git@github.com:FreshRSS/FreshRSS.git
+```
+
+You can verify the remote repo is successfully added by using:
+
+```sh
+git remote -v show
+```
+
+Now you can pull the latest development code:
+
+```sh
+git checkout edge
+git pull upstream edge
+```
+
+## Starting a new development branch
+
+```sh
+git checkout -b my-development-branch
+```
+
+## Sending a patch
+
+```sh
+# Add the changed file, here actualize_script.php
+git add app/actualize_script.php
+# Commit the change and write a proper commit message
+git commit
+# Double check all looks well
+git show
+# Push it to your fork
+git push
+```
+
+Now you can create a PR based on your branch.
+
+## How to write a commit message
+
+A commit message should succinctly describe the changes on the first line. For example:
+
+> Fix broken icon
+
+If necessary, this can be followed by a blank line and a longer explanation.
+
+For further tips, see [here](https://chris.beams.io/posts/git-commit/).