docs: clarify pull request naming#58
Conversation
|
Caution Review failedThe pull request is closed. """ WalkthroughThe contributing guidelines were updated to provide more explicit instructions for naming pull requests. The new guidelines require PR names to be written from the user's perspective and in present tense. An explanatory note was added to clarify that PR titles should describe user-facing capabilities rather than technical details, with illustrative examples contrasting effective and ineffective naming approaches. Changes
Suggested reviewers
Assessment against linked issues
📜 Recent review detailsConfiguration used: CodeRabbit UI 📒 Files selected for processing (1)
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. 🪧 TipsChatThere are 3 ways to chat with CodeRabbit:
SupportNeed help? Create a ticket on our support page for assistance with any issues or questions. Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments. CodeRabbit Commands (Invoked using PR comments)
Other keywords and placeholders
CodeRabbit Configuration File (
|
![coderabbitai[bot]](https://avatars.githubusercontent.com/in/347564?s=60&v=4){kind=small}
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/CONTRIBUTING.md (1)
215-215: Nitpick: Add missing comma for clarity
A comma after “perspective” improves readability.- This makes it immediately clear that PR names should describe features from the user's perspective rather than the technical components used to implement them. + This makes it immediately clear that PR names should describe features from the user's perspective, rather than the technical components used to implement them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~215-~215: Possible missing comma found.
Context: ...hould describe features from the user's perspective rather than the technical components us...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md
[uncategorized] ~215-~215: Possible missing comma found.
Context: ...hould describe features from the user's perspective rather than the technical components us...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (4)
.github/CONTRIBUTING.md (4)
171-174: Approve: Explicit PR naming criteria added
The new items (Conventional Commits, clean & simple, user perspective, present tense) align well with established semantic conventions and improve clarity for contributors.
188-201: Approve: Enhanced explanatory note on user-centric titles
The[!IMPORTANT]block clearly illustrates the shift from implementation to user capability and provides strong “before/after” examples.
202-208: Approve: Key differences section
The bulleted “Good examples focus on user capabilities” section succinctly reinforces the guideline.
209-214: Approve: Bad examples section
The “Bad examples focus on technical implementation” list effectively warns contributors what to avoid.
Time Submission Status
|
lucky-ivanius
changed the title
|
I can't assign reviewers @zolotokrylin |
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/CONTRIBUTING.md (2)
173-174: Consistent article usage for perspective guideline
To align with other list items (e.g., “the end users”), consider changing “a user's perspective” to “the user's perspective” for consistency.-1. be written from a user's perspective (what the user gets) +1. be written from the user's perspective (what the user gets)
215-215: Add a comma for readability
Consider placing a comma after “perspective” to improve flow.-This makes it immediately clear that PR names should describe features from the user's perspective rather than the technical components used to implement them. +This makes it immediately clear that PR names should describe features from the user's perspective, rather than the technical components used to implement them.🧰 Tools
🪛 LanguageTool
[uncategorized] ~215-~215: Possible missing comma found.
Context: ...hould describe features from the user's perspective rather than the technical components us...(AI_HYDRA_LEO_MISSING_COMMA)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(2 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md
[uncategorized] ~215-~215: Possible missing comma found.
Context: ...hould describe features from the user's perspective rather than the technical components us...
(AI_HYDRA_LEO_MISSING_COMMA)
🔇 Additional comments (2)
.github/CONTRIBUTING.md (2)
174-174: Well-defined present tense guideline
The addition clearly instructs contributors to use present tense in PR titles, which will improve consistency across PRs.
188-201: Great clarification with user-focused examples
This new >[!IMPORTANT] section effectively demonstrates the difference between naming technical components and describing user capabilities. The examples and “Think of it this way” bullets enhance understanding.
Signed-off-by: Vadim <vadim@holdex.io>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (1)
.github/CONTRIBUTING.md (1)
204-209: Nit: Remove Trailing Colon in Heading
markdownlint flagged a trailing punctuation in the heading. For consistency with other headings, consider removing the colon:-### Before Submitting, Ask: +### Before Submitting, Ask🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
204-204: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md
[grammar] ~196-~196: After ‘It’, use the third-person verb form “replaces”.
Context: ...ges. #### How to Apply It 1. Replace UI labels with actions: - 🚫 "Ad...
(IT_VBZ)
🪛 markdownlint-cli2 (0.17.2)
.github/CONTRIBUTING.md
204-204: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (5)
.github/CONTRIBUTING.md (5)
167-172: Clear and Concise Naming Intro
The three core rules (“User-focused”, “Follow Conventional Commits”, “Clear & simple”) are well-articulated and directly support the PR objectives of user-centric, consistent, present-tense titles. Great framing.
173-180: Effective Example Comparison Table
The side-by-side Good vs. Bad examples clearly demonstrate each guideline in practice. Table formatting is consistent and easy to follow.
183-188: Key Principles “What to Focus On”
Excellent explanation distinguishing technical labels from user gains, with actionable questions. The ❌/✅ icons add clarity.
190-194: Compelling “Why It Matters” Section
Succinctly articulates benefits (clarity, consistency, user-centricity) and ties back to stakeholder value.
195-202: Practical “How to Apply It” Steps
The numbered steps with concrete examples make it straightforward for contributors to translate principles into PR titles.🧰 Tools
🪛 LanguageTool
[grammar] ~196-~196: After ‘It’, use the third-person verb form “replaces”.
Context: ...ges. #### How to Apply It 1. Replace UI labels with actions: - 🚫 "Ad...(IT_VBZ)
Signed-off-by: Vadim <vadim@holdex.io>
Signed-off-by: Vadim <vadim@holdex.io>
There was a problem hiding this comment.
Actionable comments posted: 0
🧹 Nitpick comments (2)
.github/CONTRIBUTING.md (2)
186-202: Clarify pronoun in sub-heading
The heading “How to Apply It” may leave readers asking “apply what?”. Consider renaming to explicitly reference the naming principle for better clarity, e.g.:- #### **How to Apply It** + #### **How to Apply This Principle**🧰 Tools
🪛 LanguageTool
[grammar] ~199-~199: After ‘It’, use the third-person verb form “replaces”.
Context: ...ges. #### How to Apply It 1. Replace UI labels with actions: 🚫 "Add dropd...(IT_VBZ)
204-209: Remove trailing punctuation in heading
Markdownlint flags the colon at the end of the heading. For consistency, you can drop the colon:- ### Before Submitting, Ask: + ### Before Submitting, Ask🧰 Tools
🪛 markdownlint-cli2 (0.17.2)
204-204: Trailing punctuation in heading
Punctuation: ':'(MD026, no-trailing-punctuation)
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
📒 Files selected for processing (1)
.github/CONTRIBUTING.md(1 hunks)
🧰 Additional context used
🪛 LanguageTool
.github/CONTRIBUTING.md
[grammar] ~199-~199: After ‘It’, use the third-person verb form “replaces”.
Context: ...ges. #### How to Apply It 1. Replace UI labels with actions: 🚫 "Add dropd...
(IT_VBZ)
🪛 markdownlint-cli2 (0.17.2)
.github/CONTRIBUTING.md
204-204: Trailing punctuation in heading
Punctuation: ':'
(MD026, no-trailing-punctuation)
🔇 Additional comments (2)
.github/CONTRIBUTING.md (2)
167-175: Guideline language is clear and user-focused
The three bullet points (“User-focused”, “Follow Conventional Commits”, “Clear & simple”) concisely capture the naming requirements and align well with the PR objectives.
176-183: Example comparison table is helpful
The “Good vs Bad” table illustrates the dos and don’ts effectively. It reinforces the naming rules and will be valuable for new contributors.
2 participants
Resolve https://github.com/holdex/hr-member-lucky-ivanius/issues/7
Summary by CodeRabbit