Conversation
gtsiolis
requested review from
anisaoshafi,
carole-lavillonniere and
silv-io
as code owners
📝 WalkthroughWalkthroughAdded a new Changes
Estimated code review effort🎯 1 (Trivial) | ⏱️ ~3 minutes Suggested reviewers
🚥 Pre-merge checks | ✅ 2✅ Passed checks (2 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 1
🧹 Nitpick comments (1)
CONTRIBUTING.md (1)
38-38: Clarifyoutput.Sinkusage to steer contributors to helper emitters.Line 38 is directionally correct, but it may help to explicitly say “use
output.Emit*helpers” so contributors don’t try to call sink methods directly.✍️ Suggested wording tweak
-- No direct stdout/stderr printing; use `output.Sink` for user output, `log.Logger` for diagnostics +- No direct stdout/stderr printing; use `output.Sink` with `output.Emit*` helpers for user output, `log.Logger` for diagnostics🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@CONTRIBUTING.md` at line 38, Clarify the CONTRIBUTING guidance to instruct contributors to use the output.Emit* helper functions instead of calling output.Sink methods directly: update the sentence mentioning output.Sink to read something like “Use output.Sink for user output via the provided helper emitters (use output.Emit* helpers) and log.Logger for diagnostics,” ensuring you reference output.Sink and the output.Emit* helpers so readers know to prefer the Emit* helper functions rather than invoking Sink methods directly.
🤖 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 60-62: Update the fenced code blocks that show the inline CLI
examples so they include a language identifier (use "text") to satisfy
markdownlint MD040; specifically change the blocks containing "/add-command
<name>", "/add-event <EventName>", "/add-component <name>" (and the similar
examples referenced around lines 69-71 and 78-80) from ``` to ```text so each
example fence is annotated.
---
Nitpick comments:
In `@CONTRIBUTING.md`:
- Line 38: Clarify the CONTRIBUTING guidance to instruct contributors to use the
output.Emit* helper functions instead of calling output.Sink methods directly:
update the sentence mentioning output.Sink to read something like “Use
output.Sink for user output via the provided helper emitters (use output.Emit*
helpers) and log.Logger for diagnostics,” ensuring you reference output.Sink and
the output.Emit* helpers so readers know to prefer the Emit* helper functions
rather than invoking Sink methods directly.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Repository UI (base), Organization UI (inherited)
Review profile: CHILL
Plan: Pro
Run ID: 798e2465-9265-4d86-848e-cf8560c10b8c
📒 Files selected for processing (1)
CONTRIBUTING.md
| ``` | ||
| /add-command <name> | ||
| ``` |
There was a problem hiding this comment.
Add languages to fenced code blocks to satisfy markdownlint.
markdownlint warning MD040 is valid here. Please annotate these fences with a language.
🛠️ Proposed doc fix
Use the skill:
-```
+```text
/add-command <name>@@
Use the skill:
- +text
/add-event
@@
Use the skill:
-```
+```text
/add-component <name>
</details>
Also applies to: 69-71, 78-80
<details>
<summary>🧰 Tools</summary>
<details>
<summary>🪛 markdownlint-cli2 (0.21.0)</summary>
[warning] 60-60: Fenced code blocks should have a language specified
(MD040, fenced-code-language)
</details>
</details>
<details>
<summary>🤖 Prompt for AI Agents</summary>
Verify each finding against the current code and only fix it if needed.
In @CONTRIBUTING.md around lines 60 - 62, Update the fenced code blocks that
show the inline CLI examples so they include a language identifier (use "text")
to satisfy markdownlint MD040; specifically change the blocks containing
"/add-command ", "/add-event ", "/add-component " (and
the similar examples referenced around lines 69-71 and 78-80) from ``` to
|
Thanks for merging this, @carole-lavillonniere! 👾 |
2 participants
Add a basic and new
CONTRIBUTING.mdwith contribution guidelines specific to lstk.This will replace the currently inherited CONTRIBUTING.md[1] guidelines from the GitHub organization template.