diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/en/contributing.md | 2 | ||||
| -rw-r--r-- | docs/en/developers/02_First_steps.md | 12 | ||||
| -rw-r--r-- | docs/en/internationalization.md | 2 | ||||
| -rw-r--r-- | docs/fr/contributing.md | 12 | ||||
| -rw-r--r-- | docs/fr/developers/01_First_steps.md | 7 | ||||
| -rw-r--r-- | docs/fr/internationalization.md | 2 |
6 files changed, 26 insertions, 11 deletions
diff --git a/docs/en/contributing.md b/docs/en/contributing.md index a92522644..15d55d750 100644 --- a/docs/en/contributing.md +++ b/docs/en/contributing.md @@ -33,6 +33,8 @@ Would you like to fix a bug? For optimum coordination between collaborators, you If you have to write code, please follow [our coding style recommendations](developers/02_First_steps.md). +> ℹ Check [`AGENTS.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/AGENTS.md) for detailed coding conventions (both for humans and AI agents). + **Tip:** if you’re searching for easy-to-fix bugs, please have a look at the “[good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22)” ticket label. ## Submit an idea diff --git a/docs/en/developers/02_First_steps.md b/docs/en/developers/02_First_steps.md index 87c64ee2f..5b14d3493 100644 --- a/docs/en/developers/02_First_steps.md +++ b/docs/en/developers/02_First_steps.md @@ -112,10 +112,14 @@ apk add git make npm php-cli php-curl php-ctype php-dom php-mbstring php-openssl ### Tests summary +> ℹ Check [`AGENTS.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/AGENTS.md) for detailed coding conventions (both for humans and AI agents). + A short (not complete) summary: #### PHP +> ℹ Check [`php.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/php.instructions.md) for detailed coding conventions (both for humans and AI agents). + - Syntax of `php` and `phtml` files is checked. - translation files (`i18n`) are checked ([more information about i18n files](internationalization.html)). - unit test (`tests`) are run by [PHPunit](https://phpunit.de/). @@ -125,6 +129,8 @@ A short (not complete) summary: ### CSS +> ℹ Check [`css.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/css.instructions.md) for detailed coding conventions (both for humans and AI agents). + - Linter: - [PHP_Codesniffer (phpcs)](https://github.com/squizlabs/PHP_CodeSniffer) - via npm `.styleintrc.json` @@ -132,16 +138,22 @@ A short (not complete) summary: ### JavaScript +> ℹ Check [`javascript.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/javascript.instructions.md) for detailed coding conventions (both for humans and AI agents). + - Linter: - via npm `.styleintrc.json` ([ECMAScript 2017](https://en.wikipedia.org/wiki/ECMAScript#8th_Edition_%E2%80%93_ECMAScript_2017)) ### Markdown +> ℹ Check [`markdown.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/markdown.instructions.md) for detailed coding conventions (both for humans and AI agents). + - Linter: - via npm `.markdownlint.json` ## Spaces, tabs and other whitespace characters +> ℹ Check [`_general.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/_general.instructions.md) for detailed coding conventions (both for humans and AI agents). + ### Indentation Code indentation must use tabs. diff --git a/docs/en/internationalization.md b/docs/en/internationalization.md index c40285c4a..fb1ea63e5 100644 --- a/docs/en/internationalization.md +++ b/docs/en/internationalization.md @@ -43,6 +43,8 @@ Each value can be referenced by a key: it consists of a series of identifiers se You should not have to write the array by yourself and we provide several commands to ease the manipulation of these files. Let’s see some common use cases. +> ℹ Check [`freshrss-i18n/SKILL.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/skills/freshrss-i18n/SKILL.md) for detailed coding conventions (both for humans and AI agents). + ## Add support for a new language If you want to add support for a language which isn’t supported by FreshRSS yet, you can run this command: diff --git a/docs/fr/contributing.md b/docs/fr/contributing.md index 0ffbe806e..2d7d316c0 100644 --- a/docs/fr/contributing.md +++ b/docs/fr/contributing.md @@ -1,13 +1,7 @@ ## Rejoignez-nous sur les listes de mailing S’il vous manque des informations, n’hésitez pas à fouiller un peu la -documentation ou venir nous poser directement vos questions sur [la mailing -list des développeurs](https://freshrss.org/mailman/listinfo/dev). - -* Le premier mailing est destiné à l’information générique, il doit être adapté aux utilisateurs. - [Rejoignez mailing@freshrss.org](https://freshrss.org/mailman/listinfo/mailing). -* Le deuxième mailing s’adresse principalement aux développeurs. - [Rejoignez dev@freshrss.org](https://freshrss.org/mailman/listinfo/dev) +documentation ou venir nous [poser directement vos questions](https://github.com/FreshRSS/FreshRSS/discussions/categories/q-a). ## Signaler un bug @@ -30,7 +24,7 @@ suivants : Nous avons aussi besoin de quelques informations : -* Votre version de FreshRSS (sur la page A propos) ou le fichier `constants.php`) +* Votre version de FreshRSS (sur la page A propos) ou le fichier `constants.php` * Votre configuration de serveur : type d’hébergement, version PHP * Quelle base de données : SQLite, PostgreSQL, MariaDB, MySQL ? Quelle version ? * Si possible, les logs associés (logs PHP et logs FreshRSS sous `data/users/your_user/log.txt`) @@ -52,6 +46,8 @@ les collaborateurs, vous devrez suivre ces indications : Si vous devez écrire du code, veuillez suivre [nos recommandations de style de codage](developers/01_First_steps.md). +> ℹ Voir [`AGENTS.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/AGENTS.md) pour les conventions de code (à la fois pour les humains et agents IA). + **Conseil :** si vous cherchez des bugs faciles à corriger, jetez un coup d’oeil à la vignette « [good first issue](https://github.com/FreshRSS/FreshRSS/issues?q=is%3Aopen+is%3Aissue+label%3A%22good+first+issue%22) ». ## Soumettre une idée diff --git a/docs/fr/developers/01_First_steps.md b/docs/fr/developers/01_First_steps.md index 08f9436ff..de2b551ee 100644 --- a/docs/fr/developers/01_First_steps.md +++ b/docs/fr/developers/01_First_steps.md @@ -94,15 +94,16 @@ Si vous souhaitez créer votre propre extension FreshRSS, consultez la ## Style de codage +> ℹ Voir [`AGENTS.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/AGENTS.md) pour les conventions de code (à la fois pour les humains et agents IA). + Si vous désirez contribuer au code, il est important de respecter le style de codage suivant. Le code actuel ne le respecte pas entièrement mais il est de notre devoir à tous de le changer dès que l’occasion se présente. -Aucune nouvelle contribution ne respectant pas ces règles ne sera acceptée -tant que les corrections nécessaires ne sont pas appliquées. - ### Espaces, tabulations et autres caractères blancs +> ℹ Voir [`_general.instructions.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/instructions/_general.instructions.md) pour les conventions de code (à la fois pour les humains et agents IA). + #### Indentation L’indentation du code doit être faite impérativement avec des tabulations. diff --git a/docs/fr/internationalization.md b/docs/fr/internationalization.md index 778c0ade2..8d87cbec8 100644 --- a/docs/fr/internationalization.md +++ b/docs/fr/internationalization.md @@ -79,3 +79,5 @@ supérieur. C’est assez dur à expliquer mais très simple à comprendre. Dans l’exemple donné plus haut, un `_` est associé à la valeur `FreshRSS` : cela signifie qu’il n’y a pas besoin d’écrire `_t('gen.freshrss._')` mais `_t('gen.freshrss')` suffit. + +> ℹ Voir [`freshrss-i18n/SKILL.md`](https://github.com/FreshRSS/FreshRSS/blob/edge/.github/skills/freshrss-i18n/SKILL.md) pour les conventions de code (à la fois pour les humains et agents IA). |
