Skip to content

docs(contributing): use action verbs for all PR types including docs#99

Merged
angelicawill merged 1 commit intomainfrom
fix-docs-pr-naming-convention
Apr 16, 2026
Merged

docs(contributing): use action verbs for all PR types including docs#99
angelicawill merged 1 commit intomainfrom
fix-docs-pr-naming-convention

Conversation

@zolotokrylin
Copy link
Copy Markdown
Member

@zolotokrylin zolotokrylin commented Apr 14, 2026

Summary

The naming convention required user-focused action verbs, but this was only illustrated with feat/fix/test examples. The single docs example (docs(ui): design table component) used a developer-action verb ("design"), which contradicted the rule and made it easy to default to verbs like "document", "update", or "add".

Added an explicit warning after the user action verbs list clarifying the rule applies to all PR types, with a docs counterexample table.

@coderabbitai
Copy link
Copy Markdown
Contributor

coderabbitai Bot commented Apr 14, 2026

Warning

Rate limit exceeded

@zolotokrylin has exceeded the limit for the number of commits that can be reviewed per hour. Please wait 6 minutes and 51 seconds before requesting another review.

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 51 seconds.

⌛ How to resolve this issue?

After the wait time has elapsed, a review can be triggered using the @coderabbitai review command as a PR comment. Alternatively, push new commits to this PR.

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 configuration

Configuration used: Organization UI

Review profile: CHILL

Plan: Pro

Run ID: f3395f14-171d-4960-889f-a7e6ab966aa0

📥 Commits

Reviewing files that changed from the base of the PR and between 076b26d and 5dad99d.

📒 Files selected for processing (1)
  • docs/CONTRIBUTING.md
✨ Finishing Touches
🧪 Generate unit tests (beta)
  • Create PR with unit tests
  • Commit unit tests in branch fix-docs-pr-naming-convention

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.

❤️ Share

Comment @coderabbitai help to get the list of available commands and usage tips.

@zolotokrylin zolotokrylin marked this pull request as ready for review April 14, 2026 15:44
@holdex
Copy link
Copy Markdown

holdex Bot commented Apr 14, 2026

Time Submission Status

Member Status Time Action Last Update
zolotokrylin ✅ Submitted 15min Update time Apr 16, 2026, 9:28 AM
angelicawill ✅ Submitted 5min Update time Apr 16, 2026, 9:28 AM

You can submit time with the command. Example:

@holdex pr submit-time 15m

See available commands to help comply with our Guidelines.

@zolotokrylin
Copy link
Copy Markdown
Member Author

@holdex pr submit-time 15m

@angelicawill
Copy link
Copy Markdown
Contributor

@holdex pr submit-time 5m

@angelicawill angelicawill merged commit 33f7da5 into main Apr 16, 2026
5 checks passed
@angelicawill angelicawill deleted the fix-docs-pr-naming-convention branch April 16, 2026 09:28
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants