docs: add CLAUDE.md instructions

[PascalRepond]

No description provided.

[coderabbitai]

Walkthrough

Adds a new documentation file, CLAUDE.md, describing the RERO ILS Claude module: overview, tech stack, development commands, setup and testing instructions, translation workflow, architecture and module structure, code style, and testing notes.

Changes

Cohort / File(s)	Summary
Documentation CLAUDE.md	New DOC: introduces the RERO ILS Claude documentation covering overview, stack, lint/format/test commands, setup, translations workflow, architecture/module layout, base classes, signal flow, API entry points, permissions, style, and testing notes. No code or public API changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~2 minutes

🚥 Pre-merge checks | ✅ 2 | ❌ 1

❌ Failed checks (1 inconclusive)

Check name	Status	Explanation	Resolution
Description check	❓ Inconclusive	No pull request description was provided by the author, making it impossible to evaluate relevance to the changeset.	Consider adding a brief description explaining the purpose of the CLAUDE.md file and how it benefits the project.

✅ Passed checks (2 passed)

Check name	Status	Explanation
Title check	✅ Passed	The title 'docs: add CLAUDE.md instructions' clearly and concisely describes the main change—adding a new documentation file with instructions.
Docstring Coverage	✅ Passed	No functions found in the changed files to evaluate docstring coverage. Skipping docstring coverage check.

_{✏️ Tip: You can configure your own custom pre-merge checks in the settings.}

Tip

Try Coding Plans. Let us write the prompt for your AI agent so you can ship faster (with fewer bugs).
Share your feedback on Discord.

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

_{Comment @coderabbitai help to get the list of available commands and usage tips.}

[coderabbitai]

Actionable comments posted: 2

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Inline comments:
In `@CLAUDE.md`:
- Line 82: Replace the misspelled word "functionnality" with "functionality" in
the CLAUDE.md sentence that reads "Each commit must be accompanied by tests that
ensure that the functionnality works as intended."; update only that word so the
sentence now reads "...ensure that the functionality works as intended."
- Around line 41-55: The Markdown code fence showing the module layout (the
block starting with "rero_ils/modules/<module_name>/") is missing a language
tag; update the opening fence from ``` to ```text so the block becomes a ```text
fenced code block, which will satisfy the linter while leaving the contents
unchanged.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: b2b7482b-f5e5-4730-8243-712b2e22d595

📥 Commits

Reviewing files that changed from the base of the PR and between 5214d0d and b2cfe38.

📒 Files selected for processing (1)

• CLAUDE.md

[coderabbitai]

🧹 Nitpick comments (2)

CLAUDE.md (2)

23-30: Point these sections to the real setup/test instructions.

Right now both sections are effectively dead ends: they say humans should run the commands, but they do not say where those commands are documented. Adding a pointer here would make the file much more useful for newcomers and tooling.

♻️ Proposed tweak

 ### Setup (done by humans)
 
-Human developers will run the required containers, the app setup and the servers on their own terms.
+Human developers will run the required containers, the app setup and the servers on their own terms. See `README.md` or the contributor setup guide for the exact commands and prerequisites.
 
 ### Tests (done by humans)
 
-Human developers will run the needed tests from their consoles because they need to make sure the tests run only when their testing container runs.
+Human developers will run the needed tests from their consoles because they need to make sure the tests run only when their testing container runs. See `README.md` or the contributor testing guide for the supported test commands.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 23 - 30, Update the two placeholder sections "###
Setup (done by humans)" and "### Tests (done by humans)" to point readers to the
actual setup and test documentation instead of leaving them blank; replace the
passive text with explicit links or references to the real instructions (for
example, the repo README, docs/setup.md, docs/tests.md, or the test-runner/CI
scripts) and include a short one-line command example or the document path so
newcomers know where to run the commands and which container or script to use.

---

7-8: Avoid hard-coding runtime versions in this guide.

This duplicates versioned stack details that are likely defined elsewhere in project config, so CLAUDE.md will drift quickly. Prefer pointing readers to the canonical source of truth for exact versions.

♻️ Proposed tweak

-**Stack**: Python 3.12, Flask (Invenio), PostgreSQL, Elasticsearch 7, Celery, RabbitMQ, Redis
+**Stack**: Python, Flask (Invenio), PostgreSQL, Elasticsearch, Celery, RabbitMQ, Redis
+
+Use the project configuration as the source of truth for exact runtime versions.

🤖 Prompt for AI Agents

Verify each finding against the current code and only fix it if needed.

In `@CLAUDE.md` around lines 7 - 8, Remove hard-coded runtime/version strings from
the "Stack" and "Package manager" lines in CLAUDE.md and replace them with a
short pointer to the canonical configuration (e.g., project requirements,
pyproject.toml, CI matrix, or docs) so versions are maintained in one place;
update the wording to something like "See [canonical source]" or "Refer to
project config/CI for exact versions" and remove explicit mentions of "Python
3.12", "Elasticsearch 7", and the `uv`/`poethepoet` versioning details
referenced in the current Stack and Package manager lines.

🤖 Prompt for all review comments with AI agents

Verify each finding against the current code and only fix it if needed.

Nitpick comments:
In `@CLAUDE.md`:
- Around line 23-30: Update the two placeholder sections "### Setup (done by
humans)" and "### Tests (done by humans)" to point readers to the actual setup
and test documentation instead of leaving them blank; replace the passive text
with explicit links or references to the real instructions (for example, the
repo README, docs/setup.md, docs/tests.md, or the test-runner/CI scripts) and
include a short one-line command example or the document path so newcomers know
where to run the commands and which container or script to use.
- Around line 7-8: Remove hard-coded runtime/version strings from the "Stack"
and "Package manager" lines in CLAUDE.md and replace them with a short pointer
to the canonical configuration (e.g., project requirements, pyproject.toml, CI
matrix, or docs) so versions are maintained in one place; update the wording to
something like "See [canonical source]" or "Refer to project config/CI for exact
versions" and remove explicit mentions of "Python 3.12", "Elasticsearch 7", and
the `uv`/`poethepoet` versioning details referenced in the current Stack and
Package manager lines.

---

ℹ️ Review info

⚙️ Run configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: 6724051e-d389-4509-aa9d-a88b33e17951

📥 Commits

Reviewing files that changed from the base of the PR and between b2cfe38 and 80e12bd.

⛔ Files ignored due to path filters (1)

• uv.lock is excluded by !**/*.lock

📒 Files selected for processing (1)

• CLAUDE.md

[coveralls]

coverage: 92.056%. remained the same
when pulling 80e12bd on PascalRepond:rep-claude
into 5214d0d on rero:staging.