diff options
Diffstat (limited to 'docs/en/developers/02_First_steps.md')
| -rw-r--r-- | docs/en/developers/02_First_steps.md | 12 |
1 files changed, 12 insertions, 0 deletions
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. |