feat(claude): add agent skill for notification package#4073
Open
gergely-kurucz-konghq wants to merge 1 commit intomainfrom
Open
feat(claude): add agent skill for notification package#4073gergely-kurucz-konghq wants to merge 1 commit intomainfrom
gergely-kurucz-konghq wants to merge 1 commit intomainfrom
Conversation
gergely-kurucz-konghq
added
release-note/ignore
gergely-kurucz-konghq
temporarily deployed
to
dev
GitHub Actions
Inactive
Contributor
📝 WalkthroughWalkthroughAdds comprehensive documentation for the notification agent skill at Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~10 minutes 🚥 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 |
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
Contributor
There was a problem hiding this comment.
🧹 Nitpick comments (4)
.agents/skills/notification/SKILL.md (3)
14-43: Add language specifier to code block.The directory tree code block should specify a language for proper markdown linting. Consider using
textor leave it as plain```if no specific language applies.📝 Suggested fix
-``` +```text openmeter/notification/ ├── (root) — Domain types, interfaces, payload union types, event type constants🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/notification/SKILL.md around lines 14 - 43, The fenced directory-tree code block in .agents/skills/notification/SKILL.md lacks a language specifier causing markdown lint warnings; update the opening fence for that block (the tree starting with "openmeter/notification/") to include a language tag such as text (e.g., change ``` to ```text) so the linter recognizes the block as plain text and the tree renders correctly.
64-69: Add language specifier to code block.The entity hierarchy diagram should have a language tag for consistency.
📝 Suggested fix
-``` +```text Channel — webhook endpoint (URL, custom headers, signing secret) Rule — event type + config + channels (M:N, max 5 channels per rule)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/notification/SKILL.md around lines 64 - 69, Update the fenced code block at the entity hierarchy (the block starting with the triple backticks that contains "Channel — webhook endpoint..." and the following lines) to include a language specifier (e.g., change the opening "```" to "```text") so the code block is explicitly tagged; ensure only the opening fence is modified and the closing "```" remains unchanged.
124-144: Add language specifier to code block.The flow diagram should have a language tag.
📝 Suggested fix
-``` +```text Kafka (om_sys.api_events) ↓ Consumer handler (consumer/)🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.agents/skills/notification/SKILL.md around lines 124 - 144, The fenced code block containing the ASCII flow diagram in SKILL.md lacks a language specifier; update the opening fence to include a language tag (e.g., ```text) so syntax highlighters treat the diagram as plain text; find the block that starts with "Kafka (om_sys.api_events)" and modify its opening fence accordingly—the diagram references symbols like Service.CreateEvent(), adapter.CreateEvent(), EventHandler.Dispatch(), reconcileEvent()/reconcileWebhookEvent(), and webhook.SendMessage() to help you locate the correct block.AGENTS.md (1)
180-180: Consider varying sentence structure for better readability.Five consecutive sentences starting with "See" makes the paragraph a bit repetitive. You might rephrase to something like:
"Refer to the following skills:
/servicefor service/adapter patterns, constructors, input types, errors, transactions, hooks, logging, multi-tenancy, and DI wiring;/apifor HTTP handler patterns and ValidationIssue;/entfor Ent ORM patterns and Postgres type gotchas;/ledgerfor ledger package architecture, wiring, and testing;/subscriptionfor subscription domain model, sync algorithm, patch system, workflow layer, and addon sub-system;/notificationfor notification event pipeline, Kafka consumers, Svix webhook delivery, reconciliation loop, and payload versioning."Or keep them separate but vary the openings ("Refer to", "Check", "Consult", etc.).
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@AGENTS.md` at line 180, The paragraph is repetitive because five consecutive sentences start with "See"; rewrite it to vary sentence openings or combine into a single sentence listing the skills for readability—e.g., start with "Refer to the following skills:" and then list `/service` (service/adapter patterns, constructors, input types, errors, transactions, hooks, logging, multi-tenancy, DI wiring), `/api` (HTTP handler patterns, ValidationIssue), `/ent` (Ent ORM patterns, Postgres type gotchas), `/ledger` (ledger package architecture, wiring, testing), `/subscription` (subscription domain model, sync algorithm, patch system, workflow layer, addon sub-system), and `/notification` (notification event pipeline, Kafka consumers, Svix webhook delivery, reconciliation loop, payload versioning); alternatively keep separate sentences but vary openings (e.g., "Refer to", "See", "Consult") for `/service`, `/api`, `/ent`, `/ledger`, `/subscription`, and `/notification`.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Nitpick comments:
In @.agents/skills/notification/SKILL.md:
- Around line 14-43: The fenced directory-tree code block in
.agents/skills/notification/SKILL.md lacks a language specifier causing markdown
lint warnings; update the opening fence for that block (the tree starting with
"openmeter/notification/") to include a language tag such as text (e.g., change
``` to ```text) so the linter recognizes the block as plain text and the tree
renders correctly.
- Around line 64-69: Update the fenced code block at the entity hierarchy (the
block starting with the triple backticks that contains "Channel — webhook
endpoint..." and the following lines) to include a language specifier (e.g.,
change the opening "```" to "```text") so the code block is explicitly tagged;
ensure only the opening fence is modified and the closing "```" remains
unchanged.
- Around line 124-144: The fenced code block containing the ASCII flow diagram
in SKILL.md lacks a language specifier; update the opening fence to include a
language tag (e.g., ```text) so syntax highlighters treat the diagram as plain
text; find the block that starts with "Kafka (om_sys.api_events)" and modify its
opening fence accordingly—the diagram references symbols like
Service.CreateEvent(), adapter.CreateEvent(), EventHandler.Dispatch(),
reconcileEvent()/reconcileWebhookEvent(), and webhook.SendMessage() to help you
locate the correct block.
In `@AGENTS.md`:
- Line 180: The paragraph is repetitive because five consecutive sentences start
with "See"; rewrite it to vary sentence openings or combine into a single
sentence listing the skills for readability—e.g., start with "Refer to the
following skills:" and then list `/service` (service/adapter patterns,
constructors, input types, errors, transactions, hooks, logging, multi-tenancy,
DI wiring), `/api` (HTTP handler patterns, ValidationIssue), `/ent` (Ent ORM
patterns, Postgres type gotchas), `/ledger` (ledger package architecture,
wiring, testing), `/subscription` (subscription domain model, sync algorithm,
patch system, workflow layer, addon sub-system), and `/notification`
(notification event pipeline, Kafka consumers, Svix webhook delivery,
reconciliation loop, payload versioning); alternatively keep separate sentences
but vary openings (e.g., "Refer to", "See", "Consult") for `/service`, `/api`,
`/ent`, `/ledger`, `/subscription`, and `/notification`.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Path: .coderabbit.yaml
Review profile: CHILL
Plan: Pro
Run ID: 01995ddb-c3f3-4b89-95ce-303b17d01127
📒 Files selected for processing (2)
.agents/skills/notification/SKILL.mdAGENTS.md
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Overview
Add agent skill for notification package.
Summary by CodeRabbit