chore: add lock files and top-level check commands#1
Conversation
📝 WalkthroughWalkthroughThis PR standardizes CI/CD workflows and development documentation to execute tools within the Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Poem
🚥 Pre-merge checks | ✅ 3✅ Passed checks (3 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches🧪 Generate unit tests (beta)
Comment |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.github/workflows/workflow_linting.yml (1)
3-5: Consider addingpull_requestas an additional trigger.Running this lint workflow on PRs (not only pushes) catches formatting regressions before merge and shortens feedback loops.
Suggested update
on: push: + pull_request:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.github/workflows/workflow_linting.yml around lines 3 - 5, Update the workflow trigger block so the lint job runs on pull requests as well as pushes: modify the top-level "on" configuration (currently only "push") to include "pull_request" (optionally with branch filters if needed) so the workflow executes for PR events and catches formatting/regression issues before merge.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In `@CONTRIBUTING.md`:
- Around line 49-59: Normalize the heading levels to avoid a jump from "##" to
"######": change the headings "For Running Individual Toolkit Checks" and "For
Running All Toolkit Checks" to an intermediate level that follows the previous
"##" (e.g., "###" or "####") so the document follows incremental heading rules;
update the two heading markers surrounding the command blocks to the chosen
consistent level and run markdownlint/MD001 to confirm the violation is
resolved.
---
Nitpick comments:
In @.github/workflows/workflow_linting.yml:
- Around line 3-5: Update the workflow trigger block so the lint job runs on
pull requests as well as pushes: modify the top-level "on" configuration
(currently only "push") to include "pull_request" (optionally with branch
filters if needed) so the workflow executes for PR events and catches
formatting/regression issues before merge.
🪄 Autofix (Beta)
Fix all unresolved CodeRabbit comments on this PR:
- Push a commit to this branch (recommended)
- Create a new PR with the fixes
ℹ️ Review info
⚙️ Run configuration
Configuration used: defaults
Review profile: CHILL
Plan: Pro
Run ID: 78010b86-c7ea-4a76-9add-79ed0cbb8a92
⛔ Files ignored due to path filters (2)
divref/uv.lockis excluded by!**/*.lockpixi.lockis excluded by!**/*.lock
📒 Files selected for processing (5)
.github/workflows/python_package.yml.github/workflows/workflow_linting.ymlCONTRIBUTING.mdpixi.tomlworkflows/download.smk
| ###### For Running Individual Toolkit Checks | ||
|
|
||
| ```console | ||
| uv run poe check-format | ||
| uv run poe check-lint | ||
| uv run poe check-tests | ||
| uv run poe check-typing | ||
| uv run --directory divref poe check-format | ||
| uv run --directory divref poe check-lint | ||
| uv run --directory divref poe check-tests | ||
| uv run --directory divref poe check-typing | ||
| ``` | ||
|
|
||
| ###### For Running All Checks | ||
| ###### For Running All Toolkit Checks | ||
|
|
There was a problem hiding this comment.
Fix heading level jump to satisfy markdownlint (MD001).
Line 49 (and similarly Line 58) jumps from ## to ######, which violates heading increment rules.
Suggested heading-level normalization
-###### For Running Individual Toolkit Checks
+### For Running Individual Toolkit Checks
...
-###### For Running All Toolkit Checks
+### For Running All Toolkit Checks📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| ###### For Running Individual Toolkit Checks | |
| ```console | |
| uv run poe check-format | |
| uv run poe check-lint | |
| uv run poe check-tests | |
| uv run poe check-typing | |
| uv run --directory divref poe check-format | |
| uv run --directory divref poe check-lint | |
| uv run --directory divref poe check-tests | |
| uv run --directory divref poe check-typing | |
| ``` | |
| ###### For Running All Checks | |
| ###### For Running All Toolkit Checks | |
| ### For Running Individual Toolkit Checks | |
🧰 Tools
🪛 markdownlint-cli2 (0.22.0)
[warning] 49-49: Heading levels should only increment by one level at a time
Expected: h3; Actual: h6
(MD001, heading-increment)
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@CONTRIBUTING.md` around lines 49 - 59, Normalize the heading levels to avoid
a jump from "##" to "######": change the headings "For Running Individual
Toolkit Checks" and "For Running All Toolkit Checks" to an intermediate level
that follows the previous "##" (e.g., "###" or "####") so the document follows
incremental heading rules; update the two heading markers surrounding the
command blocks to the chosen consistent level and run markdownlint/MD001 to
confirm the violation is resolved.
Summary by CodeRabbit
Chores
Documentation