From 1c3159058fd256ec7163a29c9865dbd3dbe05f17 Mon Sep 17 00:00:00 2001 From: Alexandre Alapetite Date: Mon, 15 Mar 2021 00:00:25 +0100 Subject: Quick update the doc for master renaming to edge --- docs/fr/developers/01_First_steps.md | 2 +- docs/fr/developers/02_Github.md | 34 ++++++++++++++++------------ docs/fr/developers/03_Running_tests.md | 12 +++++----- docs/fr/developers/05_Release_new_version.md | 26 ++++++++++----------- 4 files changed, 40 insertions(+), 34 deletions(-) (limited to 'docs/fr/developers') diff --git a/docs/fr/developers/01_First_steps.md b/docs/fr/developers/01_First_steps.md index e7c862ae5..8c2bf4505 100644 --- a/docs/fr/developers/01_First_steps.md +++ b/docs/fr/developers/01_First_steps.md @@ -125,7 +125,7 @@ précédé par des caractères blanc. Il est possible de vérifier la présence de caractères blancs en fin de ligne grâce à Git avec la commande suivante : -```bash +```sh # commande à lancer avant l'ajout des fichiers dans l'index git diff --check # commande à lancer après l'ajout des fichiers dans l'index mais avant le commit diff --git a/docs/fr/developers/02_Github.md b/docs/fr/developers/02_Github.md index 724e56e8a..d850dee09 100644 --- a/docs/fr/developers/02_Github.md +++ b/docs/fr/developers/02_Github.md @@ -30,7 +30,7 @@ pas cet aspect "social" ! français :) 5. Merci de bien vouloir suivre les quelques conseils donnés plus bas pour faciliter la prise en compte de votre ticket. - + ## De façon informelle Tout le monde n'aime pas ou n'utilise pas GitHub pour des raisons aussi @@ -104,9 +104,10 @@ Pensez à donner les informations suivantes si vous les connaissez : version ? 5. Quelle distribution sur le serveur ? Et… quelle version ? -# Système de branches +## Système de branches + +### Élémentaire -## Élémentaire Si vous êtes novice dans Git, voici quelques ressources qui pourraient vous être utiles : @@ -115,33 +116,38 @@ Si vous êtes novice dans Git, voici quelques ressources qui pourraient vous * * -## Obtenir le dernier code du répertoire FreshRSS +### Obtenir le dernier code du répertoire FreshRSS + Vous devez avant tout ajouter le repo officiel à votre liste de repo remote : -```bash + +```sh git remote add upstream git@github.com:FreshRSS/FreshRSS.git ``` Vous pouvez vérifier que le repo remote a été ajouté avec succès en utilisant : -```bash + +```sh git remote -v show ``` Vous pouvez maintenant pull le dernier code de développement : -```bash -git checkout master -git pull upstream master + +```sh +git checkout edge +git pull upstream edge ``` -## Lancer une nouvelle branche de développement -```bash +### Lancer une nouvelle branche de développement + +```sh git checkout -b mon-branch-developpement ``` -# Proposer un patch +## Proposer un patch -```bash +```sh # Ajoutez le fichier modifié, ici actualize_script.php git add app/actualize_script.php # Commitez le changement et écrivez un message de commit approprié. @@ -154,7 +160,7 @@ git push Vous pouvez maintenant créer une PR en fonction de votre branche. -## Comment écrire un message de commit +### Comment écrire un message de commit Un message de commit devrait décrire succinctement les changements sur la première ligne. Par exemple : diff --git a/docs/fr/developers/03_Running_tests.md b/docs/fr/developers/03_Running_tests.md index 70aafc02a..90a4b72ef 100644 --- a/docs/fr/developers/03_Running_tests.md +++ b/docs/fr/developers/03_Running_tests.md @@ -1,15 +1,15 @@ # Running tests FreshRSS is tested with [PHPUnit](https://phpunit.de/). No code should be -merged in `master` if the tests don't pass. +merged in `edge` if the tests don't pass. ## Locally As a developer, you can run the test suite on your PC easily with `make` commands. You can run the test suite with: -```console -$ make test +```sh +make test ``` This command downloads the PHPUnit binary and verifies its checksum. If the @@ -20,8 +20,8 @@ maintainers know about the problem. Then, it executes PHPUnit in a Docker container. If you don't use Docker, you can run the command directly with: -```console -$ NO_DOCKER=true make test +```sh +NO_DOCKER=true make test ``` ## Travis @@ -32,4 +32,4 @@ done to ensure there is no regressions in your code. We cannot merge a PR if the tests fail so we'll ask you to fix bugs before to review your code. If you're interested in, you can take a look at [the configuration -file](https://github.com/FreshRSS/FreshRSS/blob/master/.travis.yml). +file](https://github.com/FreshRSS/FreshRSS/blob/edge/.travis.yml). diff --git a/docs/fr/developers/05_Release_new_version.md b/docs/fr/developers/05_Release_new_version.md index face8d5cb..116d50ca6 100644 --- a/docs/fr/developers/05_Release_new_version.md +++ b/docs/fr/developers/05_Release_new_version.md @@ -7,7 +7,7 @@ Ceci est à faire **au moins une semaine à l'avance**. Il est aussi recommandé de faire l'annonce sur mailing@freshrss.org. -# S'assurer de l'état de dev +## S'assurer de l'état de dev Avant de sortir une nouvelle version de FreshRSS, il faut vous assurer que le code est stable et ne présente pas de bugs majeurs. Idéalement, il @@ -17,10 +17,10 @@ publication. Il faut aussi **vous assurer que le fichier CHANGELOG est à jour** avec les mises à jour de la version à sortir. -# Processus Git +## Processus Git -```bash -$ git checkout master +```sh +$ git checkout edge $ git pull $ vim constants.php # Mettre à jour le numéro de version x.y.z de FRESHRSS_VERSION @@ -31,7 +31,7 @@ Version x.y.z $ git push && git push --tags ``` -# Mise à jour de update.freshrss.org +## Mise à jour de update.freshrss.org Il est important de mettre à jour update.freshrss.org puisqu'il s'agit du service par défaut gérant les mises à jour automatiques de FreshRSS. @@ -39,11 +39,11 @@ service par défaut gérant les mises à jour automatiques de FreshRSS. Le dépot gérant le code se trouve sur GitHub : [FreshRSS/update.freshrss.org](https://github.com/FreshRSS/update.freshrss.org/). -## Écriture du script de mise à jour +### Écriture du script de mise à jour Les scripts se trouvent dans le répertoire `./scripts/` et doivent être de la forme `update_to_x.y.z.php`. On trouve aussi dans ce répertoire -`update_to_dev.php` destiné aux mises à jour de la branche `master` (ce +`update_to_dev.php` destiné aux mises à jour de la branche `edge` (ce script ne doit pas inclure de code spécifique à une version particulière !) et `update_util.php` contenant une liste de fonctions utiles à tous les scripts. @@ -98,7 +98,7 @@ return array( Et voici comment fonctionne cette table : * à gauche se trouve la version N, à droite la version N+1 ; -* les versions `x.y.z-dev` sont **toutes** mises à jour vers `master` ; +* les versions `x.y.z-dev` sont **toutes** mises à jour vers `edge` ; * les versions stables sont mises à jour vers des versions stables ; * il est possible de sauter plusieurs versions d'un coup à condition que les scripts de mise à jour le prennent en charge ; @@ -121,7 +121,7 @@ déroule correctement. Lorsque vous serez satisfait, mettez à jour update.freshrss.org avec le nouveau script et en testant de nouveau puis passez à la suite. -# Mise à jour des services FreshRSS +## Mise à jour des services FreshRSS Deux services sont à mettre à jour immédiatement après la mise à jour de update.freshrss.org : @@ -129,7 +129,7 @@ update.freshrss.org : * rss.freshrss.org ; * demo.freshrss.org (identifiants publics : `demo` / `demodemo`). -# Annoncer publiquement la sortie +## Annoncer publiquement la sortie Lorsque tout fonctionne, il est temps d'annoncer la sortie au monde entier ! @@ -141,10 +141,10 @@ Lorsque tout fonctionne, il est temps d'annoncer la sortie au monde entier ! * sur Twitter (compte [@FreshRSS](https://twitter.com/FreshRSS)) ; * et sur mailing@freshrss.org ; -# Lancer la prochaine version de développement +## Lancer la prochaine version de développement -```bash -$ git checkout master +```sh +$ git checkout edge $ vim constants.php # Mettre à jour le numéro de version de FRESHRSS_VERSION $ vim CHANGELOG.md -- cgit v1.2.3