mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-05-18 05:14:34 -04:00
bf344cd302
* remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix word choice better reflect age of project Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * grammar fixes Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * remove double headings Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
57 lines
1.3 KiB
Markdown
57 lines
1.3 KiB
Markdown
# 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:
|
|
```bash
|
|
git remote add upstream git@github.com:FreshRSS/FreshRSS.git
|
|
```
|
|
|
|
You can verify the remote repo is successfully added by using:
|
|
```bash
|
|
git remote -v show
|
|
```
|
|
|
|
Now you can pull the latest development code:
|
|
```bash
|
|
git checkout master
|
|
git pull upstream master
|
|
```
|
|
|
|
## Starting a new development branch
|
|
```bash
|
|
git checkout -b my-development-branch
|
|
```
|
|
|
|
# Sending a patch
|
|
|
|
```bash
|
|
# 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 succintly 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/).
|