docs: avoid duplicate notifications in Goal issues#96
Merged
zolotokrylin merged 8 commits intomainfrom Apr 8, 2026
Merged
Conversation
Contributor
|
Caution Review failedPull request was closed or merged during review WalkthroughDocumentation formatting updates across multiple files (text reflowing, table alignment), added two Changes
Estimated code review effort🎯 2 (Simple) | ⏱️ ~12 minutes Possibly related PRs
Suggested reviewers
🚥 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.
Actionable comments posted: 2
🧹 Nitpick comments (2)
.claude/settings.local.json (1)
1-9:.local.jsonfiles typically shouldn't be committed.Files with
.local.*naming convention usually contain user-specific settings and belong in.gitignore.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In @.claude/settings.local.json around lines 1 - 9, Remove the committed user-specific file ".claude/settings.local.json" from the repository history (or at minimum delete it in the next commit), add a rule to .gitignore to prevent ".claude/*.local.*" (or specifically ".claude/settings.local.json") from being committed going forward, and replace the committed file with a template/example file (e.g., ".claude/settings.example.json") that documents the "permissions" structure and allowed keys like "mcp__mcp-server-github__issue_read" and "Bash(gh issue:*)" for others to copy into their local untracked file.docs/CONTRIBUTING.md (1)
193-194: Keep list items on one line.The line break doesn't improve readability. One line is simpler:
♻️ Simplify formatting
-1. [Link opened PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) - to the corresponding Problem (issue). +1. [Link opened PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword) to the corresponding Problem (issue).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 193 - 194, The list item "1. [Link opened PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue-using-a-keyword) to the corresponding Problem (issue)." should be a single line; remove the manual line break between the link and "to the corresponding Problem (issue)" so the entire list entry remains on one line in CONTRIBUTING.md.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Inline comments:
In @.claude/settings.local.json:
- Around line 5-6: Current wildcard entries "Bash(gh issue:*)" and "Bash(gh
pr:*)" grant full write permissions; replace them with explicit read-only
command patterns (e.g., "Bash(gh issue:list)", "Bash(gh issue:view)", "Bash(gh
pr:list)", "Bash(gh pr:view)") or remove the wildcard and enumerate only the
safe read-only verbs so only listing/viewing PRs and issues are allowed rather
than create/edit/merge/close.
In `@docs/CONTRIBUTING.md`:
- Around line 148-151: Replace the inconsistent callout token "[!Note]" with the
all-caps variant "[!NOTE]" to match the rest of the file; update the specific
callout line containing the SSH-commit-signature note so it uses "[!NOTE]"
(preserving the existing link and text) to ensure uniform alert syntax
throughout CONTRIBUTING.md.
---
Nitpick comments:
In @.claude/settings.local.json:
- Around line 1-9: Remove the committed user-specific file
".claude/settings.local.json" from the repository history (or at minimum delete
it in the next commit), add a rule to .gitignore to prevent ".claude/*.local.*"
(or specifically ".claude/settings.local.json") from being committed going
forward, and replace the committed file with a template/example file (e.g.,
".claude/settings.example.json") that documents the "permissions" structure and
allowed keys like "mcp__mcp-server-github__issue_read" and "Bash(gh issue:*)"
for others to copy into their local untracked file.
In `@docs/CONTRIBUTING.md`:
- Around line 193-194: The list item "1. [Link opened
PR](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue-using-a-keyword)
to the corresponding Problem (issue)." should be a single line; remove the
manual line break between the link and "to the corresponding Problem (issue)" so
the entire list entry remains on one line in CONTRIBUTING.md.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 7be60f98-8f87-4be2-8142-d5d4c92210e2
📒 Files selected for processing (2)
.claude/settings.local.jsondocs/CONTRIBUTING.md
Time Submission Status
You can submit time with the command. Example: See available commands to help comply with our Guidelines. |
Member
Author
|
@holdex pr submit-time 35m |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/CONTRIBUTING.md (1)
161-164:⚠️ Potential issue | 🟡 MinorUse consistent callout token casing (
[!NOTE]).
[!Note]is inconsistent with the rest of this file’s callout style.Suggested fix
-> [!Note] We recommend signing commits using an +> [!NOTE] +> We recommend signing commits using an > [SSH key](https://docs.github.com/en/authentication/managing-commit-signature-verification/about-commit-signature-verification#ssh-commit-signature-verification). > Ensure your Git version supports SSH signature verification (Git 2.34 or > later).🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 161 - 164, The callout token `[!Note]` is inconsistent with the rest of the file’s callout style; find the instance of the callout token (the string `[!Note]`) and change it to the uppercase form `[!NOTE]` so it matches other callouts in the document and preserves formatting around the callout block.
🤖 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/CONTRIBUTING.md`:
- Around line 103-111: The blockquote chain containing the "[!NOTE]" and
"[!IMPORTANT]" callouts has a stray blank line that breaks the contiguous ">"
chain and triggers MD028; fix it by removing the empty line between the two
callout blocks or by prefixing the separator line with ">" so the blockquote
markers remain contiguous (edit the block that starts with "[!NOTE]" and the
following "[!IMPORTANT]" callout to ensure every line in the quote begins with
">" or has no blank line between them).
---
Duplicate comments:
In `@docs/CONTRIBUTING.md`:
- Around line 161-164: The callout token `[!Note]` is inconsistent with the rest
of the file’s callout style; find the instance of the callout token (the string
`[!Note]`) and change it to the uppercase form `[!NOTE]` so it matches other
callouts in the document and preserves formatting around the callout block.
🪄 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: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1bdd2410-255d-420a-9a1a-4124a2bda08f
📒 Files selected for processing (7)
docs/ADVOCACY.mddocs/APPLICATION_SUCCESS.mddocs/COMPENSATION.mddocs/CONTRIBUTING.mddocs/LEAVE_POLICY.mddocs/PRINCIPLES.mddocs/TRIAL.md
✅ Files skipped from review due to trivial changes (6)
- docs/APPLICATION_SUCCESS.md
- docs/PRINCIPLES.md
- docs/ADVOCACY.md
- docs/COMPENSATION.md
- docs/LEAVE_POLICY.md
- docs/TRIAL.md
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Vadim <vadim@holdex.io>
… of https://github.com/holdex/developers into docs/clarify-no-duplicate-notifications-in-goal-issues
zolotokrylin
deleted the
docs/clarify-no-duplicate-notifications-in-goal-issues
branch
Member
Author
|
@holdex pr submit-time 1h 15m |
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.
Summary
Related
Summary by CodeRabbit
Documentation
Chores