Skip to content

docs: clarify log message capitalization guidance#797

Merged
kvinwang merged 1 commit into
masterfrom
docs/clarify-log-message-capitalization
Jul 20, 2026
Merged

docs: clarify log message capitalization guidance#797
kvinwang merged 1 commit into
masterfrom
docs/clarify-log-message-capitalization

Conversation

@kvinwang

Copy link
Copy Markdown
Collaborator

Summary

  • clarify that log and error messages generally start with lowercase text
  • preserve conventional capitalization for leading identifiers and acronyms
  • add a RIM example to make the exception explicit

Testing

  • Documentation-only change

Copilot AI review requested due to automatic review settings July 20, 2026 03:27

Copilot AI left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Pull request overview

This PR updates the repository’s contributor guidance (CLAUDE.md) to more precisely describe how to capitalize log and error messages, including an explicit exception for leading acronyms/identifiers (e.g., RIM).

Changes:

  • Reword the rule to “start with lowercase” rather than “never capitalize”.
  • Clarify the exception for leading identifiers/acronyms and add an explicit RIM example.
  • Remove the statement about enforcement in .cursorrules from this section.

💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.

@kvinwang
kvinwang merged commit 9bf8767 into master Jul 20, 2026
16 checks passed
@kvinwang
kvinwang deleted the docs/clarify-log-message-capitalization branch July 20, 2026 14:05
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