docs(audits): simplify audit-check guide (drop CHANGELOG step and stale inventory list) - #1727
Conversation
dac196f to
c394d0f
Compare
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: Organization UI Review profile: ASSERTIVE Plan: Pro Run ID: 📒 Files selected for processing (1)
📜 Recent review details⏰ Context from checks skipped due to timeout. (6)
🔇 Additional comments (1)
WalkthroughThe audit-check authoring guide now uses a shorter checklist, removes the requirement to add a Estimated code review effort: 1 (Trivial) | ~2 minutes Possibly related PRs
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
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. Comment |
c394d0f to
06b4cac
Compare
Individual audit checks are not tracked in CHANGELOG.md, there are too many of them. Update the guide accordingly.
The per-object list of error codes duplicated the source files and was already flagged as aging fast. Point to the checks/ folder and the existing grep command instead of maintaining a manual list.
169bec9 to
34ee574
Compare
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Caution
Some comments are outside the diff and can’t be posted inline due to platform limitations.
⚠️ Outside diff range comments (1)
packages/evolution-backend/src/services/audits/auditChecks/README.md (1)
298-300: 🎯 Functional Correctness | 🟡 Minor | ⚡ Quick winMake the inventory command match all check names.
[A-Za-z]+excludes valid identifiers containing digits or additional underscores, so the command may omit checks despite claiming to list all current checks. Use a broader identifier pattern such as[A-Za-z0-9_]+.🤖 Prompt for AI Agents
Verify each finding against current code. Fix only still-valid issues, skip the rest with a brief reason, keep changes minimal, and validate. In `@packages/evolution-backend/src/services/audits/auditChecks/README.md` around lines 298 - 300, Update the inventory command’s check-name regex to allow digits and additional underscores after the prefix, replacing the restrictive identifier pattern while preserving the existing prefix and file scope so all valid check names are listed.
🤖 Prompt for all review comments with AI agents
Verify each finding against current code. Fix only still-valid issues, skip the
rest with a brief reason, keep changes minimal, and validate.
Outside diff comments:
In `@packages/evolution-backend/src/services/audits/auditChecks/README.md`:
- Around line 298-300: Update the inventory command’s check-name regex to allow
digits and additional underscores after the prefix, replacing the restrictive
identifier pattern while preserving the existing prefix and file scope so all
valid check names are listed.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: ASSERTIVE
Plan: Pro
Run ID: b44854c9-0133-4cc0-a1d9-736e97ad5de5
📒 Files selected for processing (1)
packages/evolution-backend/src/services/audits/auditChecks/README.md
📜 Review details
⏰ Context from checks skipped due to timeout. (6)
- GitHub Check: build-and-test (24.x)
- GitHub Check: test-sequential (24.x)
- GitHub Check: check-format
- GitHub Check: code-lint
- GitHub Check: generate-and-build-generator (24.x)
- GitHub Check: pr-build-check
🔇 Additional comments (1)
packages/evolution-backend/src/services/audits/auditChecks/README.md (1)
143-143: LGTM!Also applies to: 157-157, 286-295
| ``` | ||
|
|
||
| That's it. Run `yarn workspace evolution-backend test` and open the PR. | ||
| That's it. Run `yarn workspace evolution-backend test` and open the PR. No `CHANGELOG.md` entry needed (see §4). |
There was a problem hiding this comment.
You mention twice that no changelog is required, that's too repetive and hard to maintain
| §3.1). To list all current checks: | ||
|
|
||
| ```bash | ||
| rg -n "^\s+[IHMPJVTS]{1,2}_[MIL]_[A-Za-z]+:" \ |
There was a problem hiding this comment.
It's outside the diff, but what is RG ? I don't have than on my system
| Grep before adding to avoid duplicates. Checks live in `<Object>AuditChecks.ts` | ||
| and `<Object>ExtendedAuditChecks.ts` under | ||
| [`./checks/`](./checks/), one file per survey object type (see the table in | ||
| §3.1). To list all current checks: |
There was a problem hiding this comment.
Put the table number on the same line as the previous one., it looks like a section number otherwise.
The number of steps changes too often to keep in sync in the heading (already wrong after the CHANGELOG step was dropped).
34ee574 to
cbd6630
Compare
|
|
||
| ```bash | ||
| rg -n "^\s+[IHMPJVTS]{1,2}_[MIL]_[A-Za-z]+:" \ | ||
| grep -rEn "^[[:space:]]+[IHMPJVTS]{1,2}_[MIL]_[A-Za-z]+:" \ |
There was a problem hiding this comment.
Encore faut-il avoir des une façon de savoir le nom exact à donner ou qui a été donné pour le chercher... pas sûr que je grepperais exactement ce qui est existant si j'essayais de faire un audit existant. Mais bon, peut-être qu'en lisant la doc, je saurais exactement le nom à donner...
3 participants
Summary
Split out of #1723 per @greenscientist's review comment — these two commits are unrelated to the
I_M_ContactEmailButWouldLikeToParticipateInOtherSurveysaudit check added there.CHANGELOG.md, there are too many of them.checks/folder and the existingrgcommand instead.No code changes — documentation only (
packages/evolution-backend/src/services/audits/auditChecks/README.md).Test plan
Summary by CodeRabbit
CHANGELOG.mdentry.