Skip to content

docs: clarify log message capitalization guidance #797

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

Merged
kvinwang merged 1 commit into from
Jul 20, 2026
Merged

docs: clarify log message capitalization guidance #797

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
7 changes: 4 additions & 3 deletions CLAUDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -146,11 +146,12 @@ forge clean

### Logging and Error Messages

- **Never capitalize** the first letter of log messages and error messages
- Start log messages and error messages with lowercase text
- Preserve the conventional capitalization of identifiers and acronyms when they
begin a message (for example, `RIM`, `OCSP`, or `HTTP`)
- Example: `log::info!("starting server on port {}", port);`
- Example: `anyhow::bail!("failed to connect to server");`

This rule is enforced in `.cursorrules`.
- Example: `log::warn!("RIM upstream is unavailable");`

## Key Security Concepts

Expand Down
Loading