diff options
| author | 2019-12-03 22:37:40 +0100 | |
|---|---|---|
| committer | 2019-12-03 22:37:40 +0100 | |
| commit | 705318aa39a605a4d869db588f6cffb12019a611 (patch) | |
| tree | 36383dfee24999f9928957621b655e67b20714b7 /docs/fr/developers/02_Github.md | |
| parent | 0de7e84380dff5222e6728aacbbb42abaac51dd9 (diff) | |
Translate docs with po4a (#2590)
* [i18n] Add docs po4a script
* Add proof of concept
* Add a few more translations
* Hush ShellCheck and shfmt
* Make that list po4a-friendly
* drat, this document could've probably been auto-generated
* Definitive proof that it's translated from French ;-)
* Add some brand spanking new French translation
* More translation
* Mostly finish that config page
* Fix up FAQ
* More contributing
* Dev first steps
* Let's ignore that admin stuff at the very least for now
* Translate release new version, make French the source first and copy all translations
Then replace French with English in the source.
Much quicker than any alternative route.
* And add the English translation
* Minor stylistic leftover from French
* Most of first steps
* Forgot the extensions
* Use po4a 0.56 to get rid of way too many newlines
* Fix up those newlines
* No point linking to Firefox integration anymore from the new user guide
* Start on main view
* A bunch of main view stuff
* More main view
* And some subscriptions before going to bed
* First steps for devs
* More dev first steps
* Incomplete French → English dev/GH translation
Because I need to ask about that mailing list thing
* Fix typo in docs/en/developers/02_Github.md
* Translate & complete devs/github to English
* Fix up most of extensions
* Is that supposed to be a non-breaking space? Let's see
* Match up some users/mobile access
* More users/mobile access
* Add fresh French translation to Fever API
* Fix typo
* Match frontend todo thingies
* Fix a typo
* Some extensions strings
* Remove Fx subscription service from the docs
Cf. https://github.com/FreshRSS/FreshRSS/pull/2606
* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643
* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009
* Add some more French translations
* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909
* Translate some of the meaningless stuff
* Translate the rest of contributing.md to French
* Fix conflicts
* Translate Docker first steps to French
* Update with change from #2665
* Add @aledeg corrections
* Overlooked a couple @aledeg corrections thanks to GitHub autohide
* Latest @aledeg suggestions
Diffstat (limited to 'docs/fr/developers/02_Github.md')
| -rw-r--r-- | docs/fr/developers/02_Github.md | 170 |
1 files changed, 131 insertions, 39 deletions
diff --git a/docs/fr/developers/02_Github.md b/docs/fr/developers/02_Github.md index 686b69ec4..439c70933 100644 --- a/docs/fr/developers/02_Github.md +++ b/docs/fr/developers/02_Github.md @@ -1,77 +1,169 @@ # Remonter un problème ou une suggestion -Malgré le soin apporté à FreshRSS, il se peut que des bugs apparaissent encore. Le projet est jeune et le développement dynamique, aussi celui-ci pourra être corrigé rapidement. Il se peut aussi que vous ayez en tête une fonctionnalité qui n'existe pas encore. Que celle-ci vous paraisse idiote, farfelue, inutile ou trop spécifique, il ne faut surtout pas hésiter à nous la proposer ! Très souvent des "idées en l'air" ont trouvé une oreille attentive. Ce sont les regards externes qui font le plus évoluer le projet. +Malgré le soin apporté à FreshRSS, il se peut que des bugs apparaissent +encore. Le projet est jeune et le développement dynamique, aussi celui-ci +pourra être corrigé rapidement. Il se peut aussi que vous ayez en tête une +fonctionnalité qui n'existe pas encore. Que celle-ci vous paraisse idiote, +farfelue, inutile ou trop spécifique, il ne faut surtout pas hésiter à nous +la proposer ! Très souvent des "idées en l'air" ont trouvé une oreille +attentive. Ce sont les regards externes qui font le plus évoluer le projet. -Si vous êtes convaincus qu'il faut vous faire entendre, voici la marche à suivre. +Si vous êtes convaincus qu'il faut vous faire entendre, voici la marche à +suivre. ## Sur GitHub -GitHub est la plate-forme à privilégier pour vos demandes. En effet, cela nous permet de pouvoir discuter à plusieurs sur un problème ou une suggestion et de faire émerger, souvent, des idées nouvelles. Ne négligeons pas cet aspect "social" ! - - 1. [Rendez-vous sur le gestionnaire de tickets de bugs](https://github.com/FreshRSS/FreshRSS/issues) - 2. Commencez par rechercher si une demande similaire n'a pas déjà été faite. Si oui, n'hésitez pas à ajouter votre voix à la demande. - 3. Si votre demande est nouvelle, [ouvrez un nouveau ticket de bug](https://github.com/FreshRSS/FreshRSS/issues/new) - 4. Rédigez enfin votre demande. Si vous maitrisez l'anglais, c'est la langue à privilégier car cela permet d'ouvrir la discussion à un plus grand nombre de personnes. Sinon, ce n'est pas grave, continuez en français :) - 5. Merci de bien vouloir suivre les quelques conseils donnés plus bas pour faciliter la prise en compte de votre ticket. - +GitHub est la plate-forme à privilégier pour vos demandes. En effet, cela +nous permet de pouvoir discuter à plusieurs sur un problème ou une +suggestion et de faire émerger, souvent, des idées nouvelles. Ne négligeons +pas cet aspect "social" ! + + 1. [Rendez-vous sur le gestionnaire de tickets de + bugs](https://github.com/FreshRSS/FreshRSS/issues) + 2. Commencez par rechercher si une demande similaire n'a pas déjà été + faite. Si oui, n'hésitez pas à ajouter votre voix à la demande. + 3. Si votre demande est nouvelle, [ouvrez un nouveau ticket de + bug](https://github.com/FreshRSS/FreshRSS/issues/new) + 4. Rédigez enfin votre demande. Si vous maitrisez l'anglais, c'est la + langue à privilégier car cela permet d'ouvrir la discussion à un plus + grand nombre de personnes. Sinon, ce n'est pas grave, continuez en + 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 diverses que légitimes. C'est pourquoi vous pouvez aussi nous contacter de façon plus informelle. +Tout le monde n'aime pas ou n'utilise pas GitHub pour des raisons aussi +diverses que légitimes. C'est pourquoi vous pouvez aussi nous contacter de +façon plus informelle. -* Sur [les listes de diffusion](https://freshrss.org/announce-of-the-mailing-lists.html) +* Sur [notre chat + Mattermost](https://framateam.org/signup_user_complete/?id=e2680d3e3128b9fac8fdb3003b0024ee) +* Sur [les listes de + diffusion](https://freshrss.org/announce-of-the-mailing-lists.html) * À des évènements / rencontres autour du Logiciel Libre * Autour d'une bière dans un bar * Etc. ## Conseils -Voici quelques conseils pour bien présenter votre remontée de bug ou votre suggestion : - - -* **Faites attention à l'orthographe.** même si ce n'est pas toujours facile, faites votre maximum ;) -* **Donnez un titre explicite à votre demande**, quitte à ce qu'il soit un peu long. Cela nous aide non seulement à comprendre votre demande, mais aussi à retrouver votre ticket plus tard. -* **Une demande = un ticket.** Vous pouvez avoir des tas d'idées mais vous avez peur de spammer le gestionnaire de bugs : ça ne fait rien. Il vaut mieux avoir un peu trop de tickets que trop de demandes dans un seul. On s'occupera de fermer et regrouper les demandes qui le peuvent. -* Si vous remontez un bug, pensez à nous **fournir les logs de FreshRSS** (accessibles dans les dossier ''data/log/'' de FreshRSS) **et PHP** (l'emplacement peut varier selon les distributions, mais pensez à chercher dans ''/var/log/httpd'' ou ''/var/log/apache''). -* Si vous ne trouvez pas les fichiers de logs, précisez-le dans votre ticket afin que nous sachions que vous avez déjà cherché. -* Tous les bugs ne nécessitent pas les logs, mais si vous doutez, mieux vaut nous les fournir. Les logs sont importants et très utiles pour débugguer ! -* Il se peut que les logs puissent révéler des informations plus ou moins confidentielles, **faites attention à ne rien divulguer de sensible.** - -De plus, face à un bug, je ne peux que vous encourager à suivre le format de message suivant (tiré du [site de Max & Sam](http://sametmax.com/template-de-demande-daide-en-informatique/)) : - ----- - -**Quel est mon objectif ?** +Voici quelques conseils pour bien présenter votre remontée de bug ou votre +suggestion : + + +* **Faites attention à l'orthographe.** même si ce n'est pas toujours + facile, faites votre maximum. ;) +* **Donnez un titre explicite à votre demande**, quitte à ce qu'il soit un + peu long. Cela nous aide non seulement à comprendre votre demande, mais + aussi à retrouver votre ticket plus tard. +* **Une demande = un ticket.** Vous pouvez avoir des tas d'idées mais vous + avez peur de spammer le gestionnaire de bugs : ça ne fait rien. Il vaut + mieux avoir un peu trop de tickets que trop de demandes dans un seul. On + s'occupera de fermer et regrouper les demandes qui le peuvent. +* Si vous remontez un bug, pensez à nous **fournir les logs de FreshRSS** + (accessibles dans les dossier ''data/log/'' de FreshRSS) **et PHP** + (l'emplacement peut varier selon les distributions, mais pensez à chercher + dans ''/var/log/httpd'' ou ''/var/log/apache''). +* Si vous ne trouvez pas les fichiers de logs, précisez-le dans votre ticket + afin que nous sachions que vous avez déjà cherché. +* Tous les bugs ne nécessitent pas les logs, mais si vous doutez, mieux vaut + nous les fournir. Les logs sont importants et très utiles pour débugguer ! +* Il se peut que les logs puissent révéler des informations plus ou moins + confidentielles, **faites attention à ne rien divulguer de sensible.** + +De plus, face à un bug, je ne peux que vous encourager à suivre le format de +message suivant (tiré du [site de Sam & +Max](http://sametmax.com/template-de-demande-daide-en-informatique/)) : + +### Quel est mon objectif ? Donnez le contexte général de ce que vous essayiez de faire. -**Qu’est-ce que j’ai essayé de faire ?** +### Qu’est-ce que j’ai essayé de faire ? -Expliquez pas à pas ce que vous avez fait afin que nous puissions reproduire le bug. +Expliquez pas à pas ce que vous avez fait afin que nous puissions reproduire +le bug. -**Quels résultats ai-je obtenus ?** +### Quels résultats ai-je obtenus ? -Le bug : ce que vous voyez qui n'aurez pas dû se passer. Ici vous pouvez fournir les logs. +Le bug : ce que vous voyez qui n'aurez pas dû se passer. Ici vous pouvez +fournir les logs. -**Quel était le résultat attendu ?** +### Quel était le résultat attendu ? Afin que nous comprenions bien où est le problème... au moins selon vous :p -**Quelle est ma situation ?** +### Quelle est ma situation ? Pensez à donner les informations suivantes si vous les connaissez : 1. Quel navigateur ? Quelle version ? 2. Quel serveur : Apache, Nginx ? Quelle version ? 3. Quelle version de PHP ? - 4. Quelle base de données : SQLite, MySQL, MariaDB, PostgreSQL ? Quelle version ? + 4. Quelle base de données : SQLite, MySQL, MariaDB, PostgreSQL ? Quelle + version ? 5. Quelle distribution sur le serveur ? Et… quelle version ? ----- - # Système de branches -**TODO** +## Élémentaire +Si vous êtes novice dans Git, voici quelques ressources qui pourraient vous +être utiles : + +* [Article du blog de GitHub](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/> + +## Obtenir le dernier code du répertoire FreshRSS +Vous devez avant tout ajouter le repo officiel à votre liste de repo remote +: +```bash +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 +git remote -v show +``` + +Vous pouvez maintenant pull le dernier code de développement : +```bash +git checkout dev +git pull upstream dev +``` + +## Lancer une nouvelle branche de développement +```bash +git checkout -b mon-branch-developpement +``` # Proposer un patch -**TODO**
\ No newline at end of file +```bash +# Ajoutez le fichier modifié, ici actualize_script.php +git add app/actualize_script.php +# Commitez le changement et écrivez un message de commit approprié. +git commit +# Vérifiez deux fois que tout a l'air d'aller bien +git show +# Poussez les changements sur ton fork +git push +``` + +Vous pouvez maintenant créer un PR en fonction de votre branche. S'il vous +plaît, assurez-vous de le soumettre contre la branche `dev` ! + +## Comment écrire un message de commit + +Un message de commit devrait décrire succinctement les changements sur la +première ligne. Par exemple : + +> Fixe une icône cassée + +Si nécessaire, une ligne blanche et une explication plus longue peuvent le +suivre. + +Pour d'autres conseils, voir +[ici](https://chris.beams.io/posts/git-commit/). |
