Add Hashtag Rule #2705
Add Hashtag Rule #2705
Conversation
📝 WalkthroughWalkthroughA new guideline was introduced in the documentation, specifying that contributors should avoid including arbitrary data or hashtags in pull request titles or commit messages. The guideline clarifies that hashtags may be used in PR descriptions if their purpose is explained. Changes
Sequence Diagram(s)No sequence diagram is necessary for this documentation update. 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: 1
📜 Review details
Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro
Cache: Disabled due to data retention organization setting
Knowledge Base: Disabled due to data retention organization setting
📒 Files selected for processing (1)
docs/review-process.md(1 hunks)
🧰 Additional context used
📓 Path-based instructions (6)
`*/**(html|markdown|md)`: - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure t...
*/**(html|markdown|md): - For instructional content in documentation, use a direct and authoritative tone. Avoid expressions of politeness such as 'may' or 'please', and ensure the goal of the instruction is fronted.
- Apply the Microsoft Style Guide to ensure documentation maintains clarity and conciseness.
- In step-by-step instructions, front the location phrase in the instructional sentence.
- In step-by-step instructions, front the 'goal' in the instructional sentence.
- In step-by-step instructions, if in doubt what to front, front the 'goal' before the location phrase in the instructional sentence.
- do not hyphenate terms like 'top-right' or 'bottom-left' with 'corner'
docs/review-process.md
`*/**(html|markdown|md)`: - Use bold to mark UI strings. - If "" are used to mark UI strings, replace them by bold.
*/**(html|markdown|md): - Use bold to mark UI strings.
- If "" are used to mark UI strings, replace them by bold.
docs/review-process.md
`*/**(html|markdown|md)`: - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
*/**(html|markdown|md): - Be brief in your replies and don't add fluff like "thank you for..." and "Please let me know if"
docs/review-process.md
`*/**(html|markdown|md)`: - Use sentence-style capitalization also in headings.
*/**(html|markdown|md): - Use sentence-style capitalization also in headings.
docs/review-process.md
`*/**(html|markdown|md)`: do not comment on HTML used for icons
*/**(html|markdown|md): do not comment on HTML used for icons
docs/review-process.md
`*/**(html|markdown|md)`: Avoid flagging inline HTML for embedding videos in future reviews for this repository.
*/**(html|markdown|md): Avoid flagging inline HTML for embedding videos in future reviews for this repository.
docs/review-process.md
⏰ Context from checks skipped due to timeout of 90000ms (3)
- GitHub Check: Redirect rules - developers-home-assistant
- GitHub Check: Header rules - developers-home-assistant
- GitHub Check: Pages changed - developers-home-assistant
| - Do not put arbitrary data/hashtags in the PR title or commit message as it's | ||
| unrelated to our projects. You can have the hashtag in the PR description | ||
| if you describe what it's needed for. |
There was a problem hiding this comment.
🛠️ Refactor suggestion
Rewrite directive with fronted goal and bold UI strings
Front the instruction goal and mark UI labels in bold for clarity and authoritative tone.
Apply this diff:
- Do not put arbitrary data/hashtags in the PR title or commit message as it's
- unrelated to our projects. You can have the hashtag in the PR description
- if you describe what it's needed for.
+ Only include hashtags in the **PR description** if you explain their purpose.
+ Do not include arbitrary hashtags or data in the **PR title** or **commit message**; they are unrelated to the project.📝 Committable suggestion
‼️ IMPORTANT
Carefully review the code before committing. Ensure that it accurately replaces the highlighted code, contains no missing lines, and has no issues with indentation. Thoroughly test & benchmark the code to ensure it meets the requirements.
| - Do not put arbitrary data/hashtags in the PR title or commit message as it's | |
| unrelated to our projects. You can have the hashtag in the PR description | |
| if you describe what it's needed for. | |
| Only include hashtags in the **PR description** if you explain their purpose. | |
| Do not include arbitrary hashtags or data in the **PR title** or **commit message**; they are unrelated to the project. |
🤖 Prompt for AI Agents
In docs/review-process.md around lines 207 to 209, rewrite the directive to
start with the main goal and make UI-related terms like "PR title," "commit
message," and "PR description" bold for clarity and emphasis. This will improve
readability and give the instruction a more authoritative tone.
|
Thanks for opening this, but I am not sure that we should add this to the docs, since it does not seem like a common or frequent thing to happen. |
2 participants
Proposed change
Explain that its not allowed to put hashtags in pr/commit messages. Based on home-assistant/core#146932 (comment)
Type of change
Checklist
Additional information
Summary by CodeRabbit