New /pre-ci & /feedback commands for Claude#829
Conversation
|
Note Reviews pausedIt looks like this branch is under active development. To avoid overwhelming you with review comments due to an influx of new commits, CodeRabbit has automatically paused this review. You can configure this behavior by changing the Use the following commands to manage reviews:
Use the checkboxes below for quick actions:
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review infoConfiguration used: Organization UI Review profile: CHILL Plan: Pro 📒 Files selected for processing (2)
🚧 Files skipped from review as they are similar to previous changes (1)
WalkthroughAdds two new Markdown files: 🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. 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 |
1d1f01d to
c667799
Compare
Deploying infrahub-sdk-python with
|
| Latest commit: |
6387a79
|
| Status: | ✅ Deploy successful! |
| Preview URL: | https://4c36444f.infrahub-sdk-python.pages.dev |
| Branch Preview URL: | https://pmi-20260216-new-ci-skill.infrahub-sdk-python.pages.dev |
…hat will be executed by the CI.
2309c9d to
928e723
Compare
|
For now I will remove the /refactor command. Once we will add additional documentation into /dev folder, this would be a good candidate |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
dev/commands/pre-ci.md (1)
1-1: Consider adding a document-level#heading.The file starts directly with a prose paragraph. Adding a top-level heading (e.g.,
# Run Local CI Checks) improves navigability and aligns with standard Markdown conventions for command documents.✏️ Proposed fix
+# Run Local CI Checks + Run a subset of fast CI checks locally. These are lightweight validations that catch common issues before pushing. Execute each step sequentially and stop on the first failure. Report a summary at the end.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dev/commands/pre-ci.md` at line 1, Add a top-level Markdown heading above the existing paragraph to improve navigability and match conventions; insert a line like "# Run Local CI Checks" (or use the existing opening phrase "Run a subset of fast CI checks locally." as the heading) at the very top of the document so the current paragraph becomes the lead description under that heading.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@dev/commands/pre-ci.md`:
- Around line 21-23: The "cd docs && npx --no-install vitest run" line changes
the shell's working directory for subsequent steps; change it to run the vitest
command inside a subshell so the directory change is scoped only to that command
(i.e., ensure the directory change does not persist across Bash tool calls) —
update the line containing "cd docs && npx --no-install vitest run" to use a
subshell-style invocation so later steps (like the "uv run invoke docs-validate"
step) still run from the project root.
---
Nitpick comments:
In `@dev/commands/pre-ci.md`:
- Line 1: Add a top-level Markdown heading above the existing paragraph to
improve navigability and match conventions; insert a line like "# Run Local CI
Checks" (or use the existing opening phrase "Run a subset of fast CI checks
locally." as the heading) at the very top of the document so the current
paragraph becomes the lead description under that heading.
To improve the internal documentation in the /dev folder and other parts of the software, I suggest adding a "/feedback" command to prompt Claude to tell us what knowledge was missing during the code session. Ultimately, this will lead us in a state where /refactor command will be able to use internal documentation to proceed. |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
dev/commands/feedback.md (1)
34-72: Template sub-lists are missing blank lines before them.Each
For each X:label inside the template is immediately followed by a bullet list with no blank line (e.g.,For each gap:→- **Topic**: …). While markdownlint ignores content inside fenced code blocks, any Markdown Claude emits by following this template will itself violate the project's blank-line rule.♻️ Example fix (repeat for all four "For each X:" occurrences)
### Documentation Gaps <!-- Things that should be documented but aren't --> For each gap: + - **Topic**: What's missing - **Where**: Which file should contain this (existing file to update, or new file to create) - **Why**: How this would have helped during this session - **Suggested content**: A draft of what should be added (be specific and actionable)As per coding guidelines: "Add blank lines before and after lists in Markdown files."
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dev/commands/feedback.md` around lines 34 - 72, The template in dev/commands/feedback.md has four occurrences where a "For each X:" label is immediately followed by a bullet list (e.g., "For each gap:", "For each correction:", "For each pattern:", "For each update:"), which violates the project's Markdown rule requiring blank lines before lists; edit the fenced markdown template to insert a single blank line between each "For each X:" line and its following list so each label is separated from the dash-starting items (update all four occurrences in the code block to match the blank-line-before-list guideline).
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@dev/commands/feedback.md`:
- Around line 82-83: Add a blank line between the paragraph "For approved
changes:" and the following bullet list to satisfy the project's Markdown
convention (i.e., insert an empty line before the list that starts with "- Edit
existing files when updating documentation"); update the section containing "For
approved changes:" so there is a blank line before and after the list to avoid
markdownlint failures.
---
Nitpick comments:
In `@dev/commands/feedback.md`:
- Around line 34-72: The template in dev/commands/feedback.md has four
occurrences where a "For each X:" label is immediately followed by a bullet list
(e.g., "For each gap:", "For each correction:", "For each pattern:", "For each
update:"), which violates the project's Markdown rule requiring blank lines
before lists; edit the fenced markdown template to insert a single blank line
between each "For each X:" line and its following list so each label is
separated from the dash-starting items (update all four occurrences in the code
block to match the blank-line-before-list guideline).
…i command since they are independent checks
There was a problem hiding this comment.
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 `@dev/commands/feedback.md`:
- Around line 17-80: The Markdown violates the markdownlint rule requiring blank
lines before and after lists in dev/commands/feedback.md — add a single blank
line immediately before and after every list block (including the Step 2
reference bullet list, each "For each ..." explanatory list under "Step 3:
Generate Report" and the Step 4 options list), and ensure paragraphs like the
"Format" block and headings ("Step 3: Generate Report", "Step 4: Apply Changes")
are separated from adjacent lists by blank lines; update the file so lists under
those headings (and the example fenced block) have a blank line above and below
to satisfy the lint rule.
In `@dev/commands/pre-ci.md`:
- Around line 32-35: Add a trailing blank line after the final Markdown list
(the list that starts with "Run each step in order using the Bash tool." and
ends with "Do NOT commit or push anything.") so the file ends with a blank line;
also ensure there is a blank line before the list if missing to satisfy the
guideline "Add blank lines before and after lists in Markdown files."
There was a problem hiding this comment.
♻️ Duplicate comments (1)
dev/commands/feedback.md (1)
43-44:⚠️ Potential issue | 🟡 MinorAdd blank lines before each list inside the template code block.
The four
For each …:paragraphs inside the fenced template are still followed immediately by their bullet lists with no blank line, which will trigger markdownlint MD032 failures when the template content is linted.📝 Proposed fix
For each gap: + - **Topic**: What's missingFor each correction: + - **File**: Path to the fileFor each pattern: + - **Pattern**: Description of the conventionFor each update: + - **Action**: Add / Update / RemoveAs per coding guidelines: "Add blank lines before and after lists in Markdown files."
Also applies to: 52-53, 60-61, 68-69
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@dev/commands/feedback.md` around lines 43 - 44, Insert a blank line between each "For each ..." paragraph and its following bullet list inside the fenced template in dev/commands/feedback.md so lists are separated from their preceding paragraphs; specifically, update the four occurrences of the "For each gap:" (and the similar "For each ..." paragraphs at the other noted locations) in the template so there is an empty line before the subsequent "- **Topic**: ..." bullet list to satisfy MD032 and the project's markdown guidelines.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@dev/commands/feedback.md`:
- Around line 43-44: Insert a blank line between each "For each ..." paragraph
and its following bullet list inside the fenced template in
dev/commands/feedback.md so lists are separated from their preceding paragraphs;
specifically, update the four occurrences of the "For each gap:" (and the
similar "For each ..." paragraphs at the other noted locations) in the template
so there is an empty line before the subsequent "- **Topic**: ..." bullet list
to satisfy MD032 and the project's markdown guidelines.
ℹ️ Review info
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (2)
dev/commands/feedback.mddev/commands/pre-ci.md
🚧 Files skipped from review as they are similar to previous changes (1)
- dev/commands/pre-ci.md
44392b5 to
6387a79
Compare
Why
pre-ci
To resolve issues detected by the CI, avoid back-and-forth
pushorforce-push.feedback
Enhance Claude capabilities to develop alone and respecting the code conventions and software architecture.
Goal
pre-ci
The
/pre-ciClaude command will launch a subset of CI checks locally.feedback
To identify missing documentation that would allow Claude to directly address correctly the problematics encountered during the session.
Summary by CodeRabbit