mirror of
https://github.com/FreshRSS/FreshRSS.git
synced 2026-03-27 10:43:41 -04:00
63c8fe1285
* docs: Fix broken or dead links Used the following commands to find broken links: 1. `lychee -E --dump https://freshrss.github.io/FreshRSS/en/ --include freshrss.github.io --output links.txt` 2. `lychee -v --suggest --archive wayback --timeout 5 -u "Mozilla/5.0 (X11; Linux x86_64; rv:148.0) Gecko/20100101 Firefox/148.0" --files-from links.txt --output output.txt` 3. `cat output.txt` Then did the same for https://freshrss.github.io/FreshRSS/fr/ We could look into using lychee in CI: https://github.com/lycheeverse/lychee?tab=readme-ov-file#github-action-usage * Replace PostgreSQL 16 link with current version Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Remove paragraph about bug message format * Update README with official app website links * Replace broken French images with English versions * Fix broken Fever API docs link in French docs * Replace GNU Social link with new one in `shares.php` --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
1.4 KiB
1.4 KiB
Branching
Basic
If you are new to Git, here are some of the resources you might find useful:
- GitHub’s blog post
- https://docs.github.com/en/github/getting-started-with-github/set-up-git
- 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:
git remote add upstream git@github.com:FreshRSS/FreshRSS.git
You can verify the remote repo is successfully added by using:
git remote -v show
Now you can pull the latest development code:
git checkout edge
git pull upstream edge
Starting a new development branch
git checkout -b my-development-branch
Sending a patch
# 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 (chris.beams.io).