aboutsummaryrefslogtreecommitdiff
path: root/docs/en
diff options
context:
space:
mode:
authorGravatar Alexandre Alapetite <alexandre@alapetite.fr> 2026-02-01 13:06:53 +0100
committerGravatar GitHub <noreply@github.com> 2026-02-01 13:06:53 +0100
commit5beebfcd45d48b9afde09694c85d04bfa71c14d5 (patch)
treea9c5091a5e0af8f78af3d43d7900226174a088cf /docs/en
parentdae27ebd5d367de034093c26d770d553f4a4e19e (diff)
Initial conventions for AI agents and humans: AGENTS.md, SKILLS.md, instructions.md (#8478)
Not stable yet, but initial structure https://agents.md https://agentskills.io/specification https://code.visualstudio.com/docs/copilot/customization/custom-instructions https://code.visualstudio.com/docs/copilot/customization/agent-skills
Diffstat (limited to 'docs/en')
-rw-r--r--docs/en/contributing.md2
-rw-r--r--docs/en/developers/02_First_steps.md12
-rw-r--r--docs/en/internationalization.md2
3 files changed, 16 insertions, 0 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: