Docs: replace raw setup/build commands with just tasks - #458
Docs: replace raw setup/build commands with just tasks#458Prachi-Gupta2808 wants to merge 1 commit into
Conversation
|
Caution Review failedFailed to post review comments. We encountered an issue with GitHub. Use ⚙️ Run configurationConfiguration used: Path: .coderabbit.yaml Review profile: ASSERTIVE Plan: Pro Run ID: ⛔ Files ignored due to path filters (5)
📒 Files selected for processing (54)
💤 Files with no reviewable changes (4)
🧰 Additional context used📓 Path-based instructions (18)**/*.{hpp,cpp,c,h}📄 CodeRabbit inference engine (.editorconfig)
Files:
**/*.{cpp,cc,cxx,c++,h,hpp,hxx,h++}📄 CodeRabbit inference engine (.clang-format)
Files:
**⚙️ CodeRabbit configuration file
Files:
core/**/*.{cpp,c,h,hpp}⚙️ CodeRabbit configuration file
Files:
**/*.{cpp,c,h,hpp}⚙️ CodeRabbit configuration file
Files:
**/*.md📄 CodeRabbit inference engine (.editorconfig)
Files:
docs/docs/**⚙️ CodeRabbit configuration file
Files:
.coderabbit.yaml📄 CodeRabbit inference engine (Custom checks)
Files:
example-apps/**⚙️ CodeRabbit configuration file
Files:
**/*.txt📄 CodeRabbit inference engine (.editorconfig)
Files:
.github/workflows/**⚙️ CodeRabbit configuration file
Files:
**/*.py⚙️ CodeRabbit configuration file
Files:
Dockerfile*⚙️ CodeRabbit configuration file
Files:
bindings/**⚙️ CodeRabbit configuration file
Files:
docs/docs/contributing/**⚙️ CodeRabbit configuration file
Files:
docs/docs/contributing/setup-and-dependencies/**⚙️ CodeRabbit configuration file
Files:
**/*.{js,ts,jsx,tsx}📄 CodeRabbit inference engine (.editorconfig)
Files:
{CMakeLists.txt,**/*.cmake}📄 CodeRabbit inference engine (.editorconfig)
Files:
🧠 Learnings (16)📓 Common learnings📚 Learning: 2025-12-31T17:46:54.476ZApplied to files:
📚 Learning: 2026-01-06T04:56:57.269ZApplied to files:
📚 Learning: 2026-01-06T21:06:24.476ZApplied to files:
📚 Learning: 2026-01-19T00:02:34.957ZApplied to files:
📚 Learning: 2026-02-25T21:24:19.036ZApplied to files:
📚 Learning: 2026-01-04T15:34:04.654ZApplied to files:
📚 Learning: 2026-02-22T15:20:15.304ZApplied to files:
📚 Learning: 2026-04-02T18:39:20.647ZApplied to files:
📚 Learning: 2026-04-11T22:21:32.583ZApplied to files:
📚 Learning: 2026-04-25T22:11:19.587ZApplied to files:
📚 Learning: 2026-02-25T21:24:34.055ZApplied to files:
📚 Learning: 2026-04-09T19:05:40.514ZApplied to files:
📚 Learning: 2026-05-01T22:50:11.527ZApplied to files:
📚 Learning: 2026-05-19T17:30:09.565ZApplied to files:
📚 Learning: 2026-04-27T15:40:33.329ZApplied to files:
🪛 ast-grep (0.44.0)example-apps/console-py/main.py[warning] 29-29: File path is request-/variable-derived; validate and normalize to prevent path traversal. (open-filename-from-request) 🪛 Cppcheck (2.21.0)core/src/internal/douglas_peucker.cpp[style] 104-104: The function 'dp_curve_reduction' is never used. (unusedFunction) bindings/js/src/wasm_wrapper.c[style] 44-44: The function 'image_to_svg' is never used. (unusedFunction) core/src/internal/shared_contours.cpp[style] 61-61: The function 'build_shared_loops' is never used. (unusedFunction) core/src/internal/contours.cpp[style] 834-834: The function 'coupled_smooth_junctions' is never used. (unusedFunction) 🪛 markdownlint-cli2 (0.22.1).github/PULL_REQUEST_TEMPLATE.md[warning] 11-11: First line in a file should be a top-level heading (MD041, first-line-heading, first-line-h1) 🪛 zizmor (1.26.1).github/workflows/pr-target-check.yml[warning] 21-21: permissions without explanatory comments (undocumented-permissions): needs an explanatory comment (undocumented-permissions) [warning] 9-12: insufficient job-level concurrency limits (concurrency-limits): workflow is missing concurrency setting (concurrency-limits) [info] 24-24: action functionality is already included by the runner (superfluous-actions): use (superfluous-actions) .github/workflows/release.yml[info] 43-43: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [error] 48-48: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 55-55: workflow or action definition without a name (anonymous-definition): this job (anonymous-definition) [info] 86-86: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 87-87: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 88-88: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 91-91: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 92-92: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 93-93: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [warning] 109-109: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [info] 110-110: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [warning] 157-160: credential persistence through GitHub Actions artifacts (artipacked): does not set persist-credentials: false (artipacked) [warning] 154-154: permissions without explanatory comments (undocumented-permissions): needs an explanatory comment (undocumented-permissions) [info] 147-147: workflow or action definition without a name (anonymous-definition): this job (anonymous-definition) [info] 139-139: action functionality is already included by the runner (superfluous-actions): use (superfluous-actions) [warning] 192-192: code injection via template expansion (template-injection): may expand into attacker-controllable code (template-injection) [error] 184-184: runtime artifacts potentially vulnerable to a cache poisoning attack (cache-poisoning): enables caching by default (cache-poisoning) [info] 198-198: workflow or action definition without a name (anonymous-definition): this job (anonymous-definition) [info] 178-178: action functionality is already included by the runner (superfluous-actions): use (superfluous-actions) [info] 302-302: workflow or action definition without a name (anonymous-definition): this job (anonymous-definition) [info] 280-280: action functionality is already included by the runner (superfluous-actions): use (superfluous-actions) Warning Ignoring CodeRabbit configuration file changes. For security, only the configuration from the base branch is applied for open source repositories.
WalkthroughThe PR updates repository workflows, issue/PR templates, build/task tooling, and docs around ChangesSVG Thickness and Contour Pipeline
Build Tasks and Documentation
Repository Templates and Release Automation
Runtime Guards and Formatting
Sequence Diagram(s)sequenceDiagram
participant PullRequest as Pull Request
participant PRTargetCheck as PR target check workflow
participant CreateOrUpdateComment as peter-evans/create-or-update-comment
PullRequest->>PRTargetCheck: pull_request event on main or dev
PRTargetCheck->>CreateOrUpdateComment: post warning comment
PRTargetCheck->>PullRequest: exit 1
Estimated code review effort🎯 5 (Critical) | ⏱️ ~120 minutes Possibly related PRs
Suggested labels
Suggested reviewers
Poem
🚥 Pre-merge checks | ✅ 3 | ❌ 5❌ Failed checks (2 warnings, 3 inconclusive)
✅ Passed checks (3 passed)
✨ Finishing Touches🧪 Generate unit tests (beta)
✨ Simplify code
Warning There were issues while running some tools. Please review the errors and either fix the tool's configuration or disable the tool if it's a critical failure. 🔧 ESLint
ESLint install failed. For unrecoverable errors, disable the tool in CodeRabbit configuration. 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 |
|
@Prachi-Gupta2808 see PR #446 this all have been updates |
|
Got it, I just checked it. |
|
Yeah. Can you help me address Ryan's comments on that PR? |
|
Alright @Krasner , do you want me to push directly to your branch or open a separate PR for it? |
|
Hi. What's the status on this PR? |
|
@Krasner told me it's being handled in his PR, should I delete this PR then? |
Yes you can close this PR |
What was changed & why
Updated the contributor documentation to use
justcommands instead of raw build/setup commands where equivalentjusttasks are available.Fixes: #443
Changes
justcommands.justequivalents where applicable.Testing & Verification
just docs build.just docs start.Additional Resources
N/A