docs: clarify assignment and notification rules in contributing guidelines#97
Merged
zolotokrylin merged 20 commits intomainfrom Apr 8, 2026
Merged
Conversation
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
Contributor
|
Warning Rate limit exceeded
Your organization is not enrolled in usage-based pricing. Contact your admin to enable usage-based pricing to continue reviews beyond the rate limit, or try again in 6 minutes and 55 seconds. ⌛ How to resolve this issue?After the wait time has elapsed, a review can be triggered using the We recommend that you space out your commits to avoid hitting the rate limit. 🚦 How do rate limits work?CodeRabbit enforces hourly rate limits for each developer per organization. Our paid plans have higher rate limits than the trial, open-source and free plans. In all cases, we re-allow further reviews after a brief timeout. Please see our FAQ for further information. ℹ️ Review info⚙️ Run configurationConfiguration used: Organization UI Review profile: CHILL Plan: Pro Run ID: 📒 Files selected for processing (3)
WalkthroughRemoved Changes
Estimated code review effort🎯 3 (Moderate) | ⏱️ ~20 minutes Possibly related PRs
Suggested reviewers
🚥 Pre-merge checks | ✅ 4 | ❌ 1❌ Failed checks (1 inconclusive)
✅ Passed checks (4 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: 3
🤖 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 100-102: Wrap the long paragraph that starts "The statement must
read as a **job story**: describe what the specific user **can't do** or what is
broken for them..." to the repository's markdown line-length limit to satisfy
MD013 (no hard line length violations); reflow the text into multiple lines at
the configured column width without changing wording or emphasis so the content
remains identical but each line is within the lint limit.
- Line 191: The CONTRIBUTING.md has inconsistent PR title guidance: the
checklist uses "type(scope): action" while later text uses "type(scope
[Optional]): action"; choose one canonical format and update all occurrences to
match (e.g., replace the later "type(scope [Optional]): action" with
"type(scope): action" if scope is optional note it in a single explanatory
sentence elsewhere). Ensure you change both the checklist line ("[ ] PR title
follows `type(scope): action` naming convention") and the later explanatory text
so they are identical and add a single clarifying sentence stating whether the
scope is optional and how to format it.
- Line 110: Typo: replace the contraction "it's" with the possessive "its" in
the sentence "Make sure each Problem issue is interlinked with it's Goal issue"
in CONTRIBUTING.md; update that line so it reads "Make sure each Problem issue
is interlinked with its Goal issue" to fix the possessive error.
🪄 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: 339848f6-35e0-4af3-a248-f7787bb51545
📒 Files selected for processing (3)
README.mddocs/CODE_OF_CONDUCT.mddocs/CONTRIBUTING.md
💤 Files with no reviewable changes (1)
- README.md
Time Submission Status
You can submit time with the command. Example: See available commands to help comply with our Guidelines. |
Contributor
There was a problem hiding this comment.
Actionable comments posted: 1
♻️ Duplicate comments (1)
docs/CONTRIBUTING.md (1)
168-168:⚠️ Potential issue | 🟠 MajorUnify PR title format in one canonical rule.
Line 168 and Line 226 still define two different formats (
type(scope): actionvstype(scope [Optional]): action). Keep one wording and reuse it in both places to avoid contributor confusion.Also applies to: 226-226
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` at line 168, Two PR title formats are present (`type(scope): action` and `type(scope [Optional]): action`); pick a single canonical format and make the two occurrences consistent. Replace the `type(scope [Optional]): action` wording with the chosen canonical form `type(scope): action` (or vice versa if you prefer that canonical form) wherever it appears (including the instances shown), and search the CONTRIBUTING.md for any other occurrences to update so the document uses the exact same PR title format everywhere.
🤖 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 129-132: Reflow the long markdown paragraphs that exceed the
repo's line-length limit without changing wording: break the paragraph starting
"When referencing issues or pull requests, use a list item format..." into
wrapped lines under the configured limit to satisfy MD013, and apply the same
reflow to the other flagged paragraphs (the ones corresponding to ranges 271-272
and 273-274) so each line is within the repository line-length setting while
preserving the original text.
---
Duplicate comments:
In `@docs/CONTRIBUTING.md`:
- Line 168: Two PR title formats are present (`type(scope): action` and
`type(scope [Optional]): action`); pick a single canonical format and make the
two occurrences consistent. Replace the `type(scope [Optional]): action` wording
with the chosen canonical form `type(scope): action` (or vice versa if you
prefer that canonical form) wherever it appears (including the instances shown),
and search the CONTRIBUTING.md for any other occurrences to update so the
document uses the exact same PR title format everywhere.
🪄 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: 8e59cd03-5195-4c9a-b95e-1b99d57c3aa3
📒 Files selected for processing (1)
docs/CONTRIBUTING.md
Contributor
There was a problem hiding this comment.
Actionable comments posted: 4
♻️ Duplicate comments (2)
docs/CONTRIBUTING.md (2)
46-49:⚠️ Potential issue | 🟡 MinorWrap paragraph to 80-character line limit.
This paragraph violates MD013.
🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 46 - 49, Wrap the paragraph that mentions "Goal:" (the sentence containing the `Goal:` prefix and the surrounding lines about browsing GitHub Issues, filtering, prioritizing, consulting your lead, and picking one that matches your skills) so no line exceeds 80 characters; preserve the backticked `Goal:` token and original wording/meaning while breaking lines at sensible word boundaries to satisfy MD013.
239-239:⚠️ Potential issue | 🟡 MinorUnify PR title format notation.
Line 174 uses
type(scope): actionwhile line 239 usestype(scope [Optional]): action. Pick one format and apply it consistently.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` at line 239, Update CONTRIBUTING.md to use a single PR title format notation consistently: choose either "type(scope): action" or "type(scope [Optional]): action" and replace all occurrences of the other variant so the document uses the chosen form everywhere; specifically update the two inconsistent format instances shown (the "type(scope): action" example and the "type(scope [Optional]): action" example) so they match the selected canonical notation throughout the file.
🤖 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 353-355: Wrap the offending paragraph to an 80-character line
width to satisfy MD013: reformat the sentence "This referral program applies
unless there is a separate commercial engagement between Holdex and the
contributor, in which case referral terms are governed by that agreement
instead." so lines do not exceed 80 characters while preserving wording and
punctuation; update the paragraph in CONTRIBUTING.md accordingly.
- Around line 205-207: Reflow the paragraph that begins "When introducing
functional changes, cross-check the README and update it in the same PR." to
obey an 80-character line length (MD013) by inserting line breaks so no line
exceeds 80 characters while preserving the sentence content, punctuation, and
meaning; update only that paragraph text (not surrounding sections) and ensure
markdown formatting remains valid.
- Around line 308-311: Reflow the paragraph that starts "If a PR is not ready to
merge, you **must** use **Request Changes** (reject)." so no line exceeds 80
characters to satisfy MD013; break the sentence(s) into multiple lines at
natural word boundaries, preserving the bold/parenthetical formatting and
meaning, and ensure the resulting paragraph still renders as a single Markdown
paragraph (no extra blank lines).
- Line 10: Update the capitalization of the platform name in the CONTRIBUTING.md
sentence that reads "You can use [Wizard Github App][2] and [Wizard Browser
Extension][1] to" by changing "Github" to the correct "GitHub"; search for and
replace other occurrences of "Github" (e.g., the link text "Wizard Github App")
to maintain consistent branding across the document.
---
Duplicate comments:
In `@docs/CONTRIBUTING.md`:
- Around line 46-49: Wrap the paragraph that mentions "Goal:" (the sentence
containing the `Goal:` prefix and the surrounding lines about browsing GitHub
Issues, filtering, prioritizing, consulting your lead, and picking one that
matches your skills) so no line exceeds 80 characters; preserve the backticked
`Goal:` token and original wording/meaning while breaking lines at sensible word
boundaries to satisfy MD013.
- Line 239: Update CONTRIBUTING.md to use a single PR title format notation
consistently: choose either "type(scope): action" or "type(scope [Optional]):
action" and replace all occurrences of the other variant so the document uses
the chosen form everywhere; specifically update the two inconsistent format
instances shown (the "type(scope): action" example and the "type(scope
[Optional]): action" example) so they match the selected canonical notation
throughout the file.
🪄 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: 475468fa-9402-49ce-96e2-b6ebffb7a6b3
📒 Files selected for processing (3)
.claude/worktrees/practical-babbagedocs/CONTRIBUTING.mddocs/PRINCIPLES.md
💤 Files with no reviewable changes (1)
- docs/PRINCIPLES.md
✅ Files skipped from review due to trivial changes (1)
- .claude/worktrees/practical-babbage
Contributor
There was a problem hiding this comment.
♻️ Duplicate comments (8)
docs/CONTRIBUTING.md (8)
305-308:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-If a PR is not ready to merge, you **must** use **Request Changes** (reject). -Do not leave a plain comment when rejection is warranted — comments do not -block merging, are not recorded as rejections, and prevent the author from -re-requesting a review. +If a PR is not ready to merge, you **must** use **Request Changes** +(reject). Do not leave a plain comment when rejection is warranted — +comments do not block merging, are not recorded as rejections, and +prevent the author from re-requesting a review.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 305 - 308, The paragraph beginning "If a PR is not ready to merge, you **must** use **Request Changes** (reject)." exceeds 80 characters; reflow it to wrap at ~80 characters per line (MD013) while preserving markdown emphasis and meaning—e.g., split into two shorter lines so each stays ≤80 chars and keep the sentence structure and emphasis intact.
10-10:⚠️ Potential issue | 🟡 MinorCapitalize "GitHub" correctly.
Use "GitHub" (capital H) in "Wizard GitHub App".
Proposed fix
-> You can use [Wizard Github App][2] and [Wizard Browser Extension][1] to +> You can use [Wizard GitHub App][2] and [Wizard Browser Extension][1] to🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` at line 10, Change the capitalization of "Wizard Github App" to "Wizard GitHub App" in the sentence shown (the string "Wizard Github App" in the docs line that currently reads "You can use [Wizard Github App][2] and [Wizard Browser Extension][1] to"); update that occurrence and scan for any other instances of "Github" in CONTRIBUTING.md or related docs to replace with "GitHub" for consistency.
350-352:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-> This referral program applies unless there is a separate commercial -> engagement between Holdex and the contributor, in which case referral terms -> are governed by that agreement instead. +> This referral program applies unless there is a separate commercial +> engagement between Holdex and the contributor, in which case referral +> terms are governed by that agreement instead.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 350 - 352, The paragraph "This referral program applies unless there is a separate commercial engagement between Holdex and the contributor, in which case referral terms are governed by that agreement instead." exceeds the 80‑char line length rule (MD013); reflow it to wrap at 80 characters by breaking the sentence into multiple lines (e.g., split after logical clauses such as after "contributor," and/or "in which case"), preserving the exact wording and punctuation so the meaning doesn't change.
68-70:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-Once a Goal is clear, you must identify what prevents its achievement. -Anything that acts as a barrier is considered a "Problem." Ask yourself: -"Why is this Goal not achieved, and what specifically is the problem?" +Once a Goal is clear, you must identify what prevents its +achievement. Anything that acts as a barrier is considered a +"Problem." Ask yourself: "Why is this Goal not achieved, and what +specifically is the problem?"🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 68 - 70, The paragraph under the Goals section exceeds the 80-character line-length rule (MD013); reflow the two sentences so each line is <=80 chars by wrapping text at natural break points while preserving wording and quotes (e.g., the terms "Goal" and "Problem" and the question "Why is this Goal not achieved, and what specifically is the problem?"); update the markdown to use hard line breaks or reflowed lines to satisfy the linter without changing content.
202-204:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-When introducing functional changes, cross-check the README and update it in -the same PR. If your change affects anything documented there — setup steps, -environment requirements, file references — the README must stay in sync. +When introducing functional changes, cross-check the README and update +it in the same PR. If your change affects anything documented there — +setup steps, environment requirements, file references — the README +must stay in sync.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 202 - 204, Reflow the paragraph "When introducing functional changes, cross-check the README and update it in the same PR. If your change affects anything documented there — setup steps, environment requirements, file references — the README must stay in sync." so no line exceeds 80 characters; keep the sentence content and punctuation identical but insert line breaks at logical word boundaries to wrap to 80 columns (apply to the paragraph in CONTRIBUTING.md).
46-49:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-To find a Goal to work on, browse GitHub Issues in the relevant repository and -filter for issues with the `Goal:` prefix. Prioritize issues based on their -impact and urgency. If you are unsure which Goal to choose, please consult -your lead. Pick one that matches your skills, then proceed with the steps below. +To find a Goal to work on, browse GitHub Issues in the relevant +repository and filter for issues with the `Goal:` prefix. Prioritize +issues based on their impact and urgency. If you are unsure which Goal +to choose, please consult your lead. Pick one that matches your skills, +then proceed with the steps below.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 46 - 49, The paragraph starting "To find a Goal to work on" exceeds the 80-character line length; reflow it so no line is longer than 80 chars while preserving wording and inline code formatting (the `Goal:` backticks). Edit that paragraph (the lines beginning "To find a Goal to work on, browse GitHub Issues...") to wrap sentences across multiple lines at word boundaries to comply with MD013 without changing content or meaning.
77-79:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-The statement must be a **job story** — describe what a specific user **cannot -do** or what is broken for them. Ask: _"What can [user] not do because of this -problem?"_ +The statement must be a **job story** — describe what a specific user +**cannot do** or what is broken for them. Ask: _"What can [user] not +do because of this problem?"_🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 77 - 79, The paragraph "The statement must be a **job story** — describe what a specific user **cannot do** or what is broken for them. Ask: _\"What can [user] not do because of this problem?\"_" exceeds 80 characters; reflow it to respect the MD013 80‑column limit by inserting line breaks at word boundaries (without changing wording or Markdown formatting), for example splitting into two or three lines so each line ≤80 chars while preserving emphasis and the quoted question.
73-75:⚠️ Potential issue | 🟡 MinorWrap to 80 characters.
Paragraph exceeds line length limit (MD013).
Proposed fix
-> Report each Problem as a [GitHub Issue](https://docs.github.com/en/issues) -> using the naming pattern: `Problem: [statement]`. Keep the name short -> (under 65 characters) and crystal clear. +> Report each Problem as a +> [GitHub Issue](https://docs.github.com/en/issues) using the naming +> pattern: `Problem: [statement]`. Keep the name short (under 65 +> characters) and crystal clear.🤖 Prompt for AI Agents
Verify each finding against the current code and only fix it if needed. In `@docs/CONTRIBUTING.md` around lines 73 - 75, The paragraph starting with "Report each Problem as a [GitHub Issue](https://docs.github.com/en/issues) using the naming pattern: `Problem: [statement]`." exceeds the 80-character line length; reflow this text to wrap at 80 chars (preserve the link, backticks, and the example pattern) so each line is ≤80 characters and the markdown linter rule MD013 is satisfied.
🤖 Prompt for all review comments with AI agents
Verify each finding against the current code and only fix it if needed.
Duplicate comments:
In `@docs/CONTRIBUTING.md`:
- Around line 305-308: The paragraph beginning "If a PR is not ready to merge,
you **must** use **Request Changes** (reject)." exceeds 80 characters; reflow it
to wrap at ~80 characters per line (MD013) while preserving markdown emphasis
and meaning—e.g., split into two shorter lines so each stays ≤80 chars and keep
the sentence structure and emphasis intact.
- Line 10: Change the capitalization of "Wizard Github App" to "Wizard GitHub
App" in the sentence shown (the string "Wizard Github App" in the docs line that
currently reads "You can use [Wizard Github App][2] and [Wizard Browser
Extension][1] to"); update that occurrence and scan for any other instances of
"Github" in CONTRIBUTING.md or related docs to replace with "GitHub" for
consistency.
- Around line 350-352: The paragraph "This referral program applies unless there
is a separate commercial engagement between Holdex and the contributor, in which
case referral terms are governed by that agreement instead." exceeds the 80‑char
line length rule (MD013); reflow it to wrap at 80 characters by breaking the
sentence into multiple lines (e.g., split after logical clauses such as after
"contributor," and/or "in which case"), preserving the exact wording and
punctuation so the meaning doesn't change.
- Around line 68-70: The paragraph under the Goals section exceeds the
80-character line-length rule (MD013); reflow the two sentences so each line is
<=80 chars by wrapping text at natural break points while preserving wording and
quotes (e.g., the terms "Goal" and "Problem" and the question "Why is this Goal
not achieved, and what specifically is the problem?"); update the markdown to
use hard line breaks or reflowed lines to satisfy the linter without changing
content.
- Around line 202-204: Reflow the paragraph "When introducing functional
changes, cross-check the README and update it in the same PR. If your change
affects anything documented there — setup steps, environment requirements, file
references — the README must stay in sync." so no line exceeds 80 characters;
keep the sentence content and punctuation identical but insert line breaks at
logical word boundaries to wrap to 80 columns (apply to the paragraph in
CONTRIBUTING.md).
- Around line 46-49: The paragraph starting "To find a Goal to work on" exceeds
the 80-character line length; reflow it so no line is longer than 80 chars while
preserving wording and inline code formatting (the `Goal:` backticks). Edit that
paragraph (the lines beginning "To find a Goal to work on, browse GitHub
Issues...") to wrap sentences across multiple lines at word boundaries to comply
with MD013 without changing content or meaning.
- Around line 77-79: The paragraph "The statement must be a **job story** —
describe what a specific user **cannot do** or what is broken for them. Ask:
_\"What can [user] not do because of this problem?\"_" exceeds 80 characters;
reflow it to respect the MD013 80‑column limit by inserting line breaks at word
boundaries (without changing wording or Markdown formatting), for example
splitting into two or three lines so each line ≤80 chars while preserving
emphasis and the quoted question.
- Around line 73-75: The paragraph starting with "Report each Problem as a
[GitHub Issue](https://docs.github.com/en/issues) using the naming pattern:
`Problem: [statement]`." exceeds the 80-character line length; reflow this text
to wrap at 80 chars (preserve the link, backticks, and the example pattern) so
each line is ≤80 characters and the markdown linter rule MD013 is satisfied.
ℹ️ Review info
⚙️ Run configuration
Configuration used: Organization UI
Review profile: CHILL
Plan: Pro
Run ID: 1b555444-4d28-4931-9224-6a66231e0fbf
📒 Files selected for processing (1)
docs/CONTRIBUTING.md
Member
Author
|
@holdex pr submit-time 2.5h |
Co-authored-by: coderabbitai[bot] <136622811+coderabbitai[bot]@users.noreply.github.com> Signed-off-by: Vadim <vadim@holdex.io>
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
Goal:prefix)Related
Summary by CodeRabbit