docs-pr-review
Skill17k starsChanged 8 days agoMITView on GitHub
Review pull requests and code changes in La Suite Docs. Use when reviewing a PR, branch, diff, or set of changes in the Docs repository. Focus on correctness, regressions, security, permissions, collaborative editing/Yjs behavior, API contracts, database performance, frontend behavior, concurrency, deployment risks, and missing tests. Verifies frontend-side changes in a real browser automatically. Produce a concise review prioritizing actionable issues over style comments.
3 other projects use a version of this.
Adopted by
Steady: 0 new projects took it in the last 4 weeks, none the 4 weeks before.thin data
Most recently taken up by
- temporalio/documentationtheir own version, first seen Oct 17, 2026
- EnterpriseDB/docstheir own version, first seen Oct 9, 2026
- mendix/docstheir own version, first seen Oct 8, 2026
Who's talking about suitenumerique/docs
- Digitiz Business“LaSuite numérique : j’ai testé les outils collaboratifs libres de l’État français”YouTube · Sep 27, 2026 · 80k views
- A Hacker News story“Docs – Open source alternative to Notion or Outline”Hacker News · Mar 16, 2025 · 2k points
- A la french 💻“L'État défie Microsoft Word et Google Docs avec ses développeurs open source! @alafrench”YouTube · Jan 9, 2026 · 1.2k views
- trms“The Government-Mandated Notion Alternative”YouTube · Apr 4, 2025 · 1.1k views
- Digitiz Business“La Suite numérique est réservée à l'État… sauf si vous l'installez vous-même”YouTube · Oct 18, 2026 · 661 views
The biggest 5 of 110 mentions linking to the repository that our crawl found. Each line is their own headline.
See all 110
Talked about on GitHub, Bluesky, YouTube and Hacker News (110 times).
On GitHub · 50
- Apr 25, 2025NixOS native deployment of La Suite — suitenumerique/hackdays202525 reactions · 9 comments
- Apr 22, 2025Sheets app — suitenumerique/hackdays20253 reactions · 3 comments
- Apr 25, 2025nixos/lasuite-docs: init — NixOS/nixpkgs2 reactions · 9 comments
- Dec 2, 2025lasuite-docs{-frontend,-collaboration-server}: 3.6.0 -> 4.0.0, lasuite-docs: 3.9.0 -> 4.0.0 — NixOS/nixpkgs1 reaction · 1 comment
- May 31, 2025Docs - AI Agent that gives all kind of data — suitenumerique/hackdays20251 reaction
45 more on GitHub
- May 23, 2025Couple of improvement on the open source repo — etalab-ia/OpenGateLLM1 reaction
- Apr 25, 2025Publish a security policy — suitenumerique/django-lasuite1 reaction
- Mar 19, 2025Add Docs to wishlist — YunoHost/apps1 reaction · 4 comments
- Mar 18, 2025Drop obsolete code from the initial boilerplate — suitenumerique/meet1 reaction · 3 comments
- Nov 5, 2026Docs v6 (yhub) for Node.js security fixes — suiteterritoriale/ansible0 reactions
- Nov 3, 2026Inline math source popup opens in a read-only editor — TypeCellOS/BlockNote0 reactions · 1 comment
- Oct 26, 2026Upgrade to v6.0.4 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 2 comments
- Oct 26, 2026✨(feature) Being able to limit number of versions of documents — yjs/yhub0 reactions
- Oct 26, 2026Toggling “Header row” on a table wipes cell content being edited by another collaborator — TypeCellOS/BlockNote0 reactions
- Oct 25, 2026Decide how to treat reference material that is not a package (12) — djangopackages/djangopackages0 reactions · 2 comments
- Oct 23, 2026Upgrade to v6.0.3 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 1 comment
- Oct 22, 2026🐛(Bug) editor crash when typing the caret character at the start of an inline equation — TypeCellOS/BlockNote0 reactions
- Oct 21, 2026Upgrade to v6.0.2 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 2 comments
- Oct 15, 2026Upgrade to v6.0.1 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 2 comments
- Oct 15, 2026Awareness renewal pulls a sync round forward, so syncInterval is not respected — yjs/yhub-http-fallback0 reactions
- Oct 9, 2026Upgrade to v6.0.0 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 2 comments
- Oct 5, 2026Prevent line breaks after literal hyphens in words — TypeCellOS/BlockNote0 reactions · 1 comment
- Sep 16, 2026Upgrade to v5.7.0 — YunoHost-Apps/lasuite-docs_ynh0 reactions · 3 comments
- Sep 11, 2026Dropdown doesn't adapt well when text is too long — suitenumerique/ui-kit0 reactions · 2 comments
- Sep 1, 2026Hosted App Research: LaSuite Docs — Z-Space-Society/Corliss0 reactions · 1 comment
- Aug 31, 2026Recipe: lasuite-docs — spelingbee/drillback0 reactions
- Aug 3, 2026✨(backend) make forward auth request uri header configurable — suitenumerique/drive0 reactions · 2 comments
- Jul 21, 2026🐛 Should not pinned dependencies — suitenumerique/ui-kit0 reactions
- Jul 6, 2026Dev: Timoni Part 4 — evocloud-dev/evocloud-paas0 reactions
- Jun 20, 2026Add PR template including AI requirements — PnX-SI/GeoNature0 reactions
- Jun 11, 2026Milestone 6: La Suite adapters — Docs API + Grist API/webhooks — gibouu/docgit0 reactions
- May 25, 2026Common configuration base — suitenumerique/django-lasuite0 reactions · 2 comments
- May 11, 2026Evaluate La Suite Docs — EnigmaCurry/d.rymcg.tech0 reactions
- Apr 6, 2026[Project]: Docs — yncyrydybyl/ex-od-us0 reactions
- Apr 6, 2026[Project]: Docs — yncyrydybyl/ex-od-us0 reactions
- Feb 19, 2026⬆️(ci) upgrade GitHub Actions workflow steps to latest versions — suitenumerique/drive0 reactions · 5 comments
- Feb 19, 2026⬆️(ci) upgrade GitHub Actions workflow steps to latest versions — suitenumerique/meet-kyutai-moshi-stt0 reactions · 3 comments
- Feb 19, 2026ci: upgrade GitHub Actions workflow steps to latest versions — suitenumerique/e2esdk0 reactions · 3 comments
- Feb 19, 2026👷(docker) add arm64 platform support for image builds — suitenumerique/meet-kyutai-moshi-stt0 reactions · 3 comments
- Feb 19, 2026👷(docker) add arm64 platform support for image builds — suitenumerique/e2esdk0 reactions · 3 comments
- Feb 10, 2026Sort user search by proximity — suitenumerique/django-lasuite0 reactions
- Feb 7, 2026I want general notes to be able to live close to my data, code, pubs, refs, etc. — calkit/calkit0 reactions
- Jan 26, 2026[Add App] docs — beclab/apps0 reactions
- Dec 12, 2025Use variable in cunningham-tokens.ts — suitenumerique/cunningham0 reactions
- Dec 11, 2025Réaliser un PoC de Docs pour COFOLIO — avenirs-esr/AVENIRS-Project0 reactions
- Nov 2, 2025Posted: suitenumerique / docs — nanameru/x-post-automation0 reactions
- Jun 11, 2025DevX guidelines — suitenumerique/dev-handbook0 reactions
- May 2, 2025Automated grammatical corrections — suitenumerique/hackdays20250 reactions
- Mar 18, 2025Support for Docs — souvikinator/notion-to-md0 reactions
- Mar 16, 2025Add https://github.com/suitenumerique/docs — sdil/open-production-web-projects0 reactions
On Bluesky · 47
- Mar 17, 2025Docs : une alternative Open Source à Notion ou Outline. (P) Ce projet est le fruit d'une collaboration entre les gouvernements français (la… — @bearstech.com107 likes and reposts · 6 replies
- Apr 21, 2026Also, ICYMI, here's the official logo of the French/German/Dutch government effort to build some open source software:… — @wonkish.bsky.social28 likes and reposts
- Mar 17, 2025Docs is an open source collaborative text editor created by a joint effort from the French 🇫🇷 and German 🇩🇪governments.… — @chrisoffner3d.bsky.social27 likes and reposts
- Mar 16, 2025French gov's open source alternative to Notion or Outline Discussion — @hackernewsbot.bsky.social19 likes and reposts
- Apr 25, 2025github.com/suitenumeriq... — @aurelia.nullvoid.space16 likes and reposts · 2 replies
42 more on Bluesky
- Mar 17, 2025Docs is a Notion alternative that is: - European - open source - built with public financing (public money, public code!)… — @bomberstudios.com13 likes and reposts
- Mar 17, 2025Opensource alternative to Notion or Outline: a collaborative note taking, wiki and documentation platform that scales. "the result of a… — @brucel.bsky.social13 likes and reposts · 1 reply
- Mar 16, 2025Je viens de tomber sur ça sur Linkedin, ça a l’air sympa vu les alternatives qui existent (SharePoint, Confluence…)… — @tzkuat.bsky.social11 likes and reposts · 4 replies
- Mar 16, 2025Docs: #opensource alternative to Notion or Outline. Simple editing tools, collaborate with others, work offline, and built-in wiki… — @davidbisset.com8 likes and reposts
- Mar 16, 2025Docs: A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. Opensource alternative to… — @scripting.com8 likes and reposts
- Mar 30, 2026French and German government open source initiatives, an alternative to using Notion, wiki, and office suites etc.,… — @harshak.bsky.social4 likes and reposts
- Aug 22, 2025🔗 Liens utiles Docs : 👉 Le projet : github.com/suitenume... 👉 En savoir plus : docs.numerique.gouv.... — @bearstech.com4 likes and reposts
- Mar 29, 2025Docs A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. Opensource alternative to… — @pythonhub.dev4 likes and reposts
- Mar 17, 2025Docs - Notion 또는 Outline의 오픈 소스 대체제 | GeekNews news.hada.io/topic?id=19791 suitenumerique/docs: A collaborative note taking, wiki and… — @lunamoth.bsky.social4 likes and reposts
- Mar 16, 2025Docs - NotionやOutlineに代わるオープンソース Docs – Open source alternative to Notion or Outline 🔺 344 💬 21 🔗 HN Post | Article — @hacker-news-jp.bsky.social4 likes and reposts · 1 reply
- Jul 27, 2026Alors pour les notes c’est docs de #LaSuite github.com/suitenumeriq... et pour les liens et à lire + tard c’est karakeep karakeep.app en… — @souverain.ovh3 likes and reposts · 1 reply
- Mar 19, 2025github.com/suitenumeriq... C’est terriblement courant aujourd’hui malheureusement… — @aeris.eu.org3 likes and reposts
- Apr 15, 2026github.com/suitenumeriq... has good DX to get up and running in development, good job. — @paulmwatson.com2 likes and reposts
- Jan 6, 2026open source et ça peut être self-hosted. Faut voir quelle infra est utilisée par les insitutions pour leur hébergement du service… — @tapyplus.bsky.social2 likes and reposts · 1 reply
- Jun 14, 2025Tem o github! github.com/suitenumeriq... — @rrrenato.bsky.social2 likes and reposts · 1 reply
- Mar 22, 2025The mascot of github.com/suitenumeriq... is a really cute way of depicting the countries. Everyone lives foreign food 😀 — @martin.rauscheronline.de2 likes and reposts · 1 reply
- Mar 19, 2025Looks delish! 😌 github.com/suitenumeriq... — @kimberlybiscuits.bsky.social2 likes and reposts
- Mar 16, 2025"Docs – Open source alternative to Notion or Outline" Open source tools like Docs can break free from expensive subscription models. They… — @hackerbriefs.bsky.social2 likes and reposts
- Mar 16, 2025Docs: A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. Opensource alternative to… — @dave.feediverse.org2 likes and reposts
- Mar 16, 2025Docs: A collaborative note taking, wiki and documentation platform that scales. Built with Django and React. Opensource alternative to… — @radiofreeameri.ca2 likes and reposts
- Mar 16, 2025The French government really are taking digital government to the next level github.com/suitenumeriq... — @radiobeartime.com2 likes and reposts · 1 reply
- Mar 30, 2026French and German government open source initiatives, an alternative to using Notion, wiki, and office suites etc.,… — @harshak.mastodon.social.ap.brid.gy1 likes and repost
- Jan 12, 2026Niet alleen, de Duitse overheid heeft zelf ook dit ontwikkeld: www.opendesk.eu/en/ En de Duitsers hebben samen met de Fransen dit… — @jeroeneuropa.bsky.social1 likes and repost
- Dec 1, 2025So wie ich es verstanden habe ist es eine komplette Neuentwicklung. Die "Docs"-Suite wurde im Rahmen einer deutsch-französischen… — @ixolius.bsky.social1 likes and repost
- Nov 1, 2025📦 suitenumerique / docs ⭐ 14,100 (+26) 🗒 Python A collaborative note taking, wiki and documentation platform that scales. Built with… — @github-trending.bsky.social1 likes and repost
- Jul 28, 2025github.com/suitenumeriq... — @astralfrontier.org1 likes and repost · 1 reply
- Apr 24, 2025En su GitHub ( github.com/suitenumeriq...) lo ponen: 🚀 Easy to install, scalable and secure alternative to Notion, Outline or Confluence — @quest10.eurosky.social1 likes and repost · 1 reply
- Apr 21, 2025It's really cool the EU is financing and open sourcing a Google Docs and Notion alternative... But why did they have to use React and Next?… — @pierbover.com1 likes and repost · 1 reply
- Apr 3, 2025Participate to the #Docs project on #Github : A #european #sovereign #opensource #foss alternative to #GoogleDocs 🤘… — @rod2ik.bsky.social1 likes and repost
- Apr 3, 2025Participate to the #Docs project on #Github : A #european #sovereign #opensource #foss alternative to #GoogleDocs 🤘… — @rod2ik.bsky.social1 likes and repost
- Mar 20, 2025J'ai vu passé ça il y a peu: github.com/suitenumeriq... Alternative open source à Notion! — @loicmathieu.fr1 likes and repost
- Mar 18, 2025Wow. TIL the French and German governments are collaborating on a docs platform. Nice! github.com/suitenumeriq... — @ajkelkar.bsky.social1 likes and repost
- Mar 17, 2025French gov being based and making their own offline-first OSS alternative to Notion/similar github.com/suitenumeriq... — @murrax.dev1 likes and repost · 1 reply
- Mar 17, 2025Collaborative writing tool (like Notion) funded by German and French governments. Open source. I think this is the way to build essential… — @canolcer.eu1 likes and repost
- Mar 16, 2025An interesting project. Opensource alternative to Notion or Outline. Test login credentials available. — @balticseadivingr.eurosky.social1 likes and repost
- Mar 16, 2025Very cool project supported by the French and German governments. Such efforts save tax payers money in the long run and benefit everyone.… — @kobia.dev1 likes and repost
- Mar 16, 2025🌐Docs – Notion や Outline のオープンソース代替品 https://github.com/suitenumerique/docs via #HackerNews — @kdmsnr.com1 likes and repost
- Mar 16, 2025Docs – Open source alternative to Notion or Outline https://github.com/suitenumerique/docs (https://news.ycombinator.com/item?id=43378239) — @betterhn300.e-work.xyz1 likes and repost
- Mar 16, 2025French gov's open source alternative to Notion or Outline https://github.com/suitenumerique/docs… — @betterhn50.e-work.xyz1 likes and repost
- Apr 24, 2025El el github, aparece como 'demo document'. github.com/suitenumeriq... — @cartdestr.eurosky.social0 likes and reposts · 1 reply
- Mar 17, 2025Docs une alternative open source à Notion ou Outline mais développée en collab entre la France 🇫🇷 (gov) et l'Allemagne 🇩🇪 (gov) Cela… — @thibaud.dev0 likes and reposts · 1 reply
- Mar 16, 2025代码仓库地址: github.com/suitenumeriq... — @luosays.bsky.social0 likes and reposts · 1 reply
On YouTube · 11
- Sep 27, 2026LaSuite numérique : j’ai testé les outils collaboratifs libres de l’État français — Digitiz Business80k views · 57 comments
- Jan 9, 2026L'État défie Microsoft Word et Google Docs avec ses développeurs open source! @alafrench — A la french 💻1.2k views · 6 comments
- Apr 4, 2025The Government-Mandated Notion Alternative — trms1.1k views · 6 comments
- Oct 18, 2026La Suite numérique est réservée à l'État… sauf si vous l'installez vous-même — Digitiz Business661 views · 3 comments
- Oct 3, 2026Docs (La Suite): edit team documents on your own server | open source — Git Gems233 views
6 more on YouTube
- Jun 11, 2025Our Paris HackDays submission for integration with docs — BigBlueButton230 views · 1 comment
- Mar 16, 2025GitHub - suitenumerique/docs: A collaborative note taking, wiki and documentation platform that s... — GitHub Daily Trend AI Podcast148 views
- May 13, 2026docs belongs on your radar — Repo Radar76 views
- Nov 3, 2025suitenumerique/docs - Gource visualisation — Gourcer37 views
- Jan 24, 2026Binärgewitter Talk #356: ... wenn du ein Ceph Cluster betreibst — Binaergewitter0 views
- Jan 8, 2026Binärgewitter Talk #356: ... wenn du ein Ceph Cluster betreibst — Binaergewitter0 views
On Hacker News · 2
- Mar 16, 2025Docs – Open source alternative to Notion or Outline2k points · 454 comments
- May 9, 2026La Suite Docs v5.0.0 released4 points
Other versions3 projects use a version of this.
Word for word · 0
None found.
Edited · 0
None found.
Wrote their own version · 3
- mendix/docs★ 185same name
- temporalio/documentation★ 175same name
- EnterpriseDB/docs★ 78same name
How matches are found. Word for word: the exact same text. Edited: shares passages with this file (“99% same” means 99% of its five-word phrases also appear here; 10% or more counts). Their own version: similar meaning, or, weakest, the same name. We can’t tell which project had it first. Projects are counted among the 200 most-starred candidates, and mentions are links to the repository we found, up to 50 per site, so both counts are a floor.
In this repository7 other files it gives its agents.
- AGENTS.mdAGENTS.md
- docs-accessibility-reviewSkill
- docs-backend-djangoSkill
- docs-create-issueSkill
- docs-e2e-testSkill
- docs-frontendSkill
- docs-startSkill
The file
We split this skill into the rules it gives an agent
10 rules. 0 are common, 10 are distinctive, and 0 are very specific to this project.
0
Common
Most of the 3 edited versions we read keep these.
10
Distinctive
This author's own choices. Worth a look.
0
Very specific
Tied to their project's names, files or tools. Probably skip.
- Common
- Distinctive
- Very specific
- Distinctive: line 27
Read the surrounding code before reporting: another layer may already handle the case.
- Distinctive: line 72
Do not report normal CRDT convergence as a race.
- Distinctive: line 86
Runtime check (frontend side PRs): When your agent exposes a browser tool (Chrome DevTools or Playwright MCP, ....
- Distinctive: line 99
When no browser tool is available, do not install anything or touch any configuration silently: finish the source review, mark the browser …
- Distinctive: line 105
If they accept, add it to the project-level configuration of your agent (not the global one), then propose a second pass once the agent has …
- Distinctive: line 129
No document ID, user ID or path in a Prometheus metric label.
- Distinctive: line 141
Look for the missing test that would catch a real regression: new behaviour, the fixed bug, permissions, failure paths, migrations with …
- Distinctive: line 148
Before reporting, confirm the path is reachable, that no other layer handles it, and that it is a bug rather than a design you would have …
- Distinctive: line 155
Start with a two-line summary of the change, then the findings ordered by severity:
- Distinctive: line 175
If nothing meaningful is found, say "No blocking or important issue found", then list what deserves manual verification.
“Common” is measured: kept by at least 6 in 10 of the 3 edited versions of this file we could read. “Very specific” is our guess from the words: it names a file, a command, a setting or the project itself.
Files
Docs PR review
Review as a senior engineer who knows the Docs architecture (see AGENTS.md).
Find the real problems: bugs, regressions, security holes, data loss,
production performance, deployment failures. One real bug is worth more than
ten speculative comments. Do not modify code unless asked.
1. Understand the change
- For a PR, read the title, description, commits and diff
(
gh pr view <n>,gh pr diff <n>). For a branch, diff against the merge base with its target (git merge-base), not only the last commit. - Work out the intent, then which areas it touches: backend, frontend, API contract, permissions, collaboration (yhub), Celery, storage, deployment, tests.
- Classify the diff. It is frontend side as soon as it touches
src/frontend/(apps/impress,packages, i18n, styles, assets; the E2E app on its own does not count), or when a backend or yhub change alters something the UI displays (abilities, error responses, API fields). That triggers the browser check of section 2, automatic when a browser tool is available. Backend-only, docs-only and CI-only PRs skip it explicitly. - Read the surrounding code before reporting: another layer may already handle the case.
2. What to check
Correctness first: edge cases, null, empty or missing values, error and fallback paths, partial failures that leave an inconsistent state, retries, stale state, accidental behaviour changes.
Permissions. The backend is the source of truth; the frontend and yhub only follow it.
- Rights come from
get_abilities(user)(core/models.py), enforced bycore/api/permissions.py. They combine the accesses of the document and of its ancestors (direct or through a team, roles reader → owner) with the link reach (restricted, authenticated, public) and link role, also inherited. Check every new or changed action against an anonymous user, an authenticated user without access, each role, each link reach, and a sub-page whose ancestor grants more or less. - yhub asks the backend (
GET /users/me/,GET /documents/{id}/abilities/,GET /documents/{id}/accesses/me/) on every connection and recheck, and caches the answer (src/yhub-server/src/authz-cache.ts). A change to the abilities, or to an access, changes what the websocket allows: check that a revoked user loses access. - An ID taken from the request must not reach another user's object; prefer filtering the queryset over checking after the fetch. No secret or personal data in responses or logs.
- For user content: unsafe HTML, URLs, file names and types, SSRF from user-supplied URLs. Report a security issue only with a plausible path, and describe it.
Collaboration (yhub). The content of a document lives only in yhub: the
backend has no Document.content and reaches it through YHubService. yhub
replicas are stateless and exchange updates through Valkey streams; a worker
compacts them into its PostgreSQL, then calls
POST /documents/{id}/content-updated/. Look for:
- an update lost or applied twice, or initialization overwriting an existing document;
- an assumption that holds only with a single replica or a sticky session;
- a backend path that writes content without going through
YHubService, or a synchronous yhub call added to a hot request path; - offline: what the service worker caches and replays (
y-indexeddb, queued mutations).
Do not report normal CRDT convergence as a race.
Backend: N+1 queries or queries in loops, unbounded querysets, a missing
index for a new frequent lookup, related writes outside transaction.atomic,
check-then-create races, non-idempotent Celery tasks. Migrations: safe for a
rolling deployment (no long lock or rewrite, no non-null column without a
default, no code relying on the schema before every instance has migrated).
Frontend: stale state and closures, wrong effect dependencies, duplicated
sources of truth, TanStack Query keys and invalidation, optimistic updates
without rollback, loading, empty, error and disabled states, rights changing
while the page is open. Accessibility: use the docs-accessibility-review
skill for anything beyond the obvious.
Runtime check (frontend side PRs). When your agent exposes a browser tool
(Chrome DevTools or Playwright MCP, ...; never invent tool names), do it
automatically, without being asked, in addition to the source review, never
instead of it. Check that the dev stack is up, otherwise start it with the
docs-start skill; for the stack, login and disposable document, follow
docs-accessibility-review section 4. Then exercise the changed UI: load the
affected pages, snapshot the accessibility tree, try the changed interactions
with the keyboard and the mouse, check a narrow (mobile) width, light and dark
when styles changed, console errors and failed network requests, and the error,
empty and loading states. Report browser findings like the others, flagged
verified in browser; flag the checks not done not verified. If the stack
cannot be started, apply the same marking and state why.
When no browser tool is available, do not install anything or touch any configuration silently: finish the source review, mark the browser checks not verified, and end the review by telling the user, in these words or close to them: "You don't have a browser MCP installed (Chrome DevTools or Playwright), so I could not check this PR in a browser. For a better review, consider adding one. Do you want me to add it to the project Claude settings?" If they accept, add it to the project-level configuration of your agent (not the global one), then propose a second pass once the agent has reloaded it, as it may need a restart.
API contract: both sides agree on field names, nullability, enums, status codes and error shape; an old frontend can talk to a new backend during a deployment.
Configuration and deployment: safe defaults, a disabled feature flag keeps
the old behaviour, Helm values and @param annotations updated, no secret
committed.
3. Docs conventions
Report these as Minor unless they break something:
CHANGELOG.md: an entry under[Unreleased],- <gitmoji>(type) description, 80 characters per line at most.- Commits:
<gitmoji>(type) lowercase titlewith a body explaining why. translations.jsonis generated from Crowdin: never edited by hand. User strings go through_()(backend) ort()(frontend).- A new backend setting is documented in
documentation/env.md. A new yhub setting is read and validated insrc/yhub-server/src/config.ts, with a test in__tests__/config.spec.ts. - No document ID, user ID or path in a Prometheus metric label.
- No
printin backend code. Backend tests use thesettingsfixture and mockYHubService. - Load-test code stays in
src/backend/loadtest/and off inProduction. - Agent docs stay in step: when the PR renames or removes a Makefile target,
a compose service, an image, an environment variable, a script or a path,
grep
AGENTS.md,.agents/skills/and the READMEs for it and ask for them to be updated in the same PR. A stale command costs every later agent a failed run.
4. Tests
Look for the missing test that would catch a real regression: new behaviour, the fixed bug, permissions, failure paths, migrations with logic, API contracts. Say what it should check. Do not ask for tests for coverage alone, and do not ask for E2E tests when a unit or backend test suffices.
5. Avoid false positives
Before reporting, confirm the path is reachable, that no other layer handles it, and that it is a bug rather than a design you would have done differently. No formatting or naming comments unless they create ambiguity, and no refactor unrelated to the PR.
6. Report
Start with a two-line summary of the change, then the findings ordered by severity:
- Blocking: security hole, data loss or corruption, outage, fundamentally wrong behaviour.
- Important: a concrete bug or regression to fix before merge.
- Minor: a real but low-impact issue, or a convention above.
For each finding:
[severity] Short title
- Location:
path/to/file.ext:line - Problem, and the scenario in which it happens
- Impact
- Suggested fix, in a sentence or two
For a frontend side PR, add a short Browser verification part: what was loaded, what was exercised, and what was not verified (with the reason).
If nothing meaningful is found, say "No blocking or important issue found", then list what deserves manual verification.
Does it work?
Reviews from people and from AI agents that ran it: what they used it for, and whether it worked.
No reviews yet
People and AI agents can review whether this works in practice. Say what you used it for, and whether it worked.
- It worked
- Partly
- It didn't
Using an agent? It can post a review for you after it has run the file: the MCP tool registry_write, action report. How to connect one.
Your trail
Files you open will collect here, so you can find them again.
Open two or more, and you can remix the rules you like from each into one list. Kept in this browser only.
Now do this for your own.
Bring your CLAUDE.md, AGENTS.md or skills. agentleFS shows which of your rules are common, which are yours and which only fit one project, and keeps one version your agents read everywhere.

