add .agents/skills/build/SKILL.md for build conventions#2019
add .agents/skills/build/SKILL.md for build conventions#2019LeiWang1999 merged 3 commits intotile-ai:mainfrom
Conversation
|
👋 Hi! Thank you for contributing to the TileLang project. Please remember to run We appreciate you taking this step! Our team will review your contribution, and we look forward to your awesome work! 🚀 |
|
No actionable comments were generated in the recent review. 🎉 ℹ️ Recent review info⚙️ Run configurationConfiguration used: defaults Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (1)
✅ Files skipped from review due to trivial changes (1)
📝 WalkthroughWalkthroughAdded a new documentation file Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Possibly related PRs
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)
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 |
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
.agents/skills/build/SKILL.md (1)
1-48: Consider adding installation verification and clearer use-case guidance.The documentation would benefit from:
- A brief command to verify successful installation (e.g.,
python -c "import tilelang; print(tilelang.__version__)")- Clearer guidance on when to use standard vs. development build approach (e.g., "Use standard install for testing or using the package; use development build when actively modifying C++ code")
📚 Suggested additions
Add after line 22:
To verify installation: ```bash python -c "import tilelang; print(tilelang.__version__)"Add clarification to line 5: ```diff -The standard way to build and install: +The standard way to build and install (use this for general usage and testing):Add clarification to line 25:
-If you need faster iteration (e.g. calling `cmake` directly to recompile C++ without re-running the full pip install), install build dependencies first: +If you're actively developing C++ code and need faster iteration (avoiding pip's full build process on each change), install build dependencies first:🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/build/SKILL.md around lines 1 - 48, Add an installation verification step and a short decision guide to the Build & Install docs: insert a one-line verification command (e.g., a python one-liner that imports tilelang and prints its __version__) after the “Build dependencies…” paragraph and add a concise sentence or two near the “Alternative: Development Build…” section that explains when to use the standard pip install (for normal testing/usage) versus when to use the development/no-build-isolation flow (when actively changing C++ sources and iterating with cmake). Reference the SKILL.md sections titled “Installing / Rebuilding tilelang” and “Alternative: Development Build with `--no-build-isolation`” when making these additions.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.agents/skills/build/SKILL.md:
- Around line 34-36: The "Editable Installs" section currently states the
opposite of pip's behavior; update the paragraph under the "Editable Installs"
header so it correctly explains that `pip install .` (non-editable) copies the
package into site-packages and Python will import the installed copy, while `pip
install -e .` creates an editable install that points imports at the local
source directory; edit the sentence that mentions `./tilelang` and "installed
copy" to reflect this correct behavior and keep the guidance to avoid editable
installs if that remains desired.
---
Nitpick comments:
In @.agents/skills/build/SKILL.md:
- Around line 1-48: Add an installation verification step and a short decision
guide to the Build & Install docs: insert a one-line verification command (e.g.,
a python one-liner that imports tilelang and prints its __version__) after the
“Build dependencies…” paragraph and add a concise sentence or two near the
“Alternative: Development Build…” section that explains when to use the standard
pip install (for normal testing/usage) versus when to use the
development/no-build-isolation flow (when actively changing C++ sources and
iterating with cmake). Reference the SKILL.md sections titled “Installing /
Rebuilding tilelang” and “Alternative: Development Build with
`--no-build-isolation`” when making these additions.
🪄 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: 9296c80b-947f-47e0-8777-db561357af10
📒 Files selected for processing (1)
.agents/skills/build/SKILL.md
…pencode-build-skill
|
Do you think it is necessary to add a build solution that incorporates |
Document the recommended C++ development workflow (cmake + PYTHONPATH), clarify editable install guidance, and add specific test invocation examples. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
* add .agents/skills/build/SKILL.md for build conventions * Add cmake+PYTHONPATH workflow and improve build docs in SKILL.md Document the recommended C++ development workflow (cmake + PYTHONPATH), clarify editable install guidance, and add specific test invocation examples. Co-Authored-By: Claude Opus 4.6 (1M context) <noreply@anthropic.com> --------- Co-authored-by: LeiWang1999 <leiwang1999@outlook.com> Co-authored-by: Claude Opus 4.6 (1M context) <noreply@anthropic.com>
Summary by CodeRabbit