From 2ed91026fcfef83ce5ef466a15e078229a106a6f Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Wed, 15 May 2024 08:58:10 +0200 Subject: Correct casing for GitHub (#6460) --- docs/en/developers/01_Index.md | 2 +- docs/en/developers/02_GitHub.md | 62 ++++++++++++++++++++++++++ docs/en/developers/02_Github.md | 62 -------------------------- docs/en/developers/03_Backend/05_Extensions.md | 2 +- 4 files changed, 64 insertions(+), 64 deletions(-) create mode 100644 docs/en/developers/02_GitHub.md delete mode 100644 docs/en/developers/02_Github.md (limited to 'docs/en/developers') diff --git a/docs/en/developers/01_Index.md b/docs/en/developers/01_Index.md index c3787377a..0e59b8c12 100644 --- a/docs/en/developers/01_Index.md +++ b/docs/en/developers/01_Index.md @@ -6,7 +6,7 @@ Start by creating your development environment. A guide to setting up FreshRSS ## After That -* [Github Branching and Pushing](02_Github.md) +* [GitHub Branching and Pushing](02_GitHub.md) * [Running tests](03_Running_tests.md) * [Creating a pull request](04_Pull_requests.md) * [Releasing a new version](05_Release_new_version.md) 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) +* +* +* + +## 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/). diff --git a/docs/en/developers/02_Github.md b/docs/en/developers/02_Github.md deleted file mode 100644 index 066d6ffb0..000000000 --- a/docs/en/developers/02_Github.md +++ /dev/null @@ -1,62 +0,0 @@ -# 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) -* -* -* - -## 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/). diff --git a/docs/en/developers/03_Backend/05_Extensions.md b/docs/en/developers/03_Backend/05_Extensions.md index 602625cf8..164a309ed 100644 --- a/docs/en/developers/03_Backend/05_Extensions.md +++ b/docs/en/developers/03_Backend/05_Extensions.md @@ -2,7 +2,7 @@ ## About FreshRSS -FreshRSS is an RSS / Atom feed aggregator written in PHP dating back to October 2012. The official site is located at [freshrss.org](https://freshrss.org) and the official repository is hosted on Github: [github.com/FreshRSS/FreshRSS](https://github.com/FreshRSS/FreshRSS). +FreshRSS is an RSS / Atom feed aggregator written in PHP dating back to October 2012. The official site is located at [freshrss.org](https://freshrss.org) and the official repository is hosted on GitHub: [github.com/FreshRSS/FreshRSS](https://github.com/FreshRSS/FreshRSS). ## The problem -- cgit v1.2.3