Conversation
|
Thank you so much for contributing to Blueprints! Now that you've created your pull request, please don't go away; take a look at the bottom of this page for the automated checks that should already be running. If they pass, great! If not, please click on 'Details' and see if you can fix the problem they've identified. A maintainer should be along shortly to review your pull request and help get it added! |
📝 WalkthroughWalkthroughExtended Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Poem
🚥 Pre-merge checks | ✅ 5✅ Passed checks (5 passed)
✏️ Tip: You can configure your own custom pre-merge checks in the settings. ✨ Finishing Touches📝 Generate docstrings
🧪 Generate unit tests (beta)
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 |
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #1005 +/- ##
=========================================
Coverage 100.00% 100.00%
=========================================
Files 441 441
Lines 13673 13673
=========================================
Hits 13673 13673 ☔ View full report in Codecov by Sentry. 🚀 New features to boost your workflow:
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
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 `@docs/guides/contribute/cli.md`:
- Around line 32-40: The docs example calling subprocess.run to execute the CLI
help is currently ignoring failures; update the call to subprocess.run (the
invocation that runs ["blueprints", "--help"]) to pass check=True so that
subprocess.CalledProcessError is raised on non-zero exit and the docs build
fails fast; keep the rest of the invocation (capture_output, text, env)
unchanged and ensure the result variable (result) is still used to print
result.stdout.
In `@docs/guides/contribute/new-feature.md`:
- Line 94: Replace the incorrect contributor line "Sina Zel taat
([`@SZeltaat`](https://github.com/SZeltaat))" with the correctly formatted name
that matches the GitHub handle; update it to "Sina Zeltaat
([`@SZeltaat`](https://github.com/SZeltaat))" so the display name and spacing are
consistent with the handle.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 3ebb3c0c-a8a6-484c-afc1-f2e949fc9f67
📒 Files selected for processing (4)
.gitignoredocs/guides/contribute/cli.mddocs/guides/contribute/index.mddocs/guides/contribute/new-feature.md
| ```python exec="on" result="ansi" | ||
| import subprocess, os | ||
| result = subprocess.run( | ||
| ["blueprints", "--help"], | ||
| capture_output=True, | ||
| text=True, | ||
| env={**os.environ, "COLUMNS": "80", "FORCE_COLOR": "1"}, | ||
| ) | ||
| print(result.stdout) |
There was a problem hiding this comment.
Fail fast when blueprints --help execution fails.
The snippet currently ignores command failures; docs can render with missing/empty help output. Add check=True so docs build fails loudly when CLI help cannot be generated.
Suggested patch
- import subprocess, os
+ import os
+ import subprocess
result = subprocess.run(
["blueprints", "--help"],
capture_output=True,
text=True,
+ check=True,
env={**os.environ, "COLUMNS": "80", "FORCE_COLOR": "1"},
)
print(result.stdout)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed.
In `@docs/guides/contribute/cli.md` around lines 32 - 40, The docs example calling
subprocess.run to execute the CLI help is currently ignoring failures; update
the call to subprocess.run (the invocation that runs ["blueprints", "--help"])
to pass check=True so that subprocess.CalledProcessError is raised on non-zero
exit and the docs build fails fast; keep the rest of the invocation
(capture_output, text, env) unchanged and ensure the result variable (result) is
still used to print result.stdout.
1 participant
Description
Hi there,
This is the contribution guide for introducing new features. Please let me know if you agree on its content. And if you have suggestions to improve it.
Here's the preview
Fixes #999
It also contains a small fix on the cli guideline. Don't worry about it 😉
Type of change
Checklist:
Summary by CodeRabbit
Documentation
Chores