Skip to content

Add Hashtag Rule #2705

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed

Add Hashtag Rule #2705

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/review-process.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -204,6 +204,10 @@ requested the changes that the PR is ready to go!
don't hesitate to ask for help in our
[#devs channel in our Discord chat](https://www.home-assistant.io/join-chat).

- 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.
Comment on lines +207 to +209
Copy link
Contributor

@coderabbitai coderabbitai bot Jun 17, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🛠️ 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.

Suggested change
- 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.


## My PR has been merged!

Congratulations! 🎉
Expand Down