Skip to content

llm: Expand string resource naming convention in CLAUDE.md#6856

Merged
aj-rosado merged 1 commit intomainfrom
llm/improve-string-resources-claude-md
Apr 30, 2026
Merged

llm: Expand string resource naming convention in CLAUDE.md#6856
aj-rosado merged 1 commit intomainfrom
llm/improve-string-resources-claude-md

Conversation

@aj-rosado
Copy link
Copy Markdown
Contributor

🎟️ Tracking

Internal tooling improvement — no Jira ticket.

📔 Objective

Expands the string resource guidance in CLAUDE.md to include the naming convention: each resource name should be derived from its own text content in snake_case, rather than using generic suffixes like _message or _title.

For example:

  • one_or_more_email_addresses_are_incorrect
  • invalid_email_addresses_message

This helps Claude (and contributors) produce consistent, self-documenting string resource names from the start, reducing review churn.

@aj-rosado aj-rosado added the ai-review-vnext Request a Claude code review using the vNext workflow label Apr 30, 2026
@github-actions github-actions Bot added t:docs Change Type - Documentation t:llm Change Type - LLM related change (e.g. CLAUDE.md files) labels Apr 30, 2026
@github-actions
Copy link
Copy Markdown
Contributor

github-actions Bot commented Apr 30, 2026

🤖 Bitwarden Claude Code Review

Overall Assessment: APPROVE

Reviewed a single-line documentation update to .claude/CLAUDE.md that expands the string resource guidance with a naming convention (derive resource names from text content in snake_case, avoid generic _message/_title suffixes). The change is scoped to Claude Code instructions, contains no runtime or build impact, and the PR description provides clear before/after examples.

Code Review Details

No findings. The change is well-scoped, accurately documented, and consistent with the surrounding Code Style & Standards section.

@aj-rosado aj-rosado changed the title docs: Expand string resource naming convention in CLAUDE.md llm: Expand string resource naming convention in CLAUDE.md Apr 30, 2026
@aj-rosado aj-rosado removed the t:docs Change Type - Documentation label Apr 30, 2026
@codecov
Copy link
Copy Markdown

codecov Bot commented Apr 30, 2026

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 86.36%. Comparing base (336b13c) to head (4c81a20).
⚠️ Report is 2 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #6856   +/-   ##
=======================================
  Coverage   86.36%   86.36%           
=======================================
  Files         823      823           
  Lines       59019    59019           
  Branches     8669     8669           
=======================================
  Hits        50972    50972           
  Misses       5058     5058           
  Partials     2989     2989           
Flag Coverage Δ
app-data 17.54% <ø> (ø)
app-ui-auth-tools 20.12% <ø> (ø)
app-ui-platform 15.85% <ø> (ø)
app-ui-vault 25.66% <ø> (ø)
authenticator 6.65% <ø> (ø)
lib-core-network-bridge 4.30% <ø> (ø)
lib-data-ui 1.03% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.

🚀 New features to boost your workflow:
  • ❄️ Test Analytics: Detect flaky tests, report on failures, and find test suite problems.

@aj-rosado aj-rosado marked this pull request as ready for review April 30, 2026 15:27
@aj-rosado aj-rosado requested a review from a team as a code owner April 30, 2026 15:27
Comment thread .claude/CLAUDE.md
- **Naming**: `camelCase` (vars/fns), `PascalCase` (classes), `SCREAMING_SNAKE_CASE` (constants), `...Impl` (implementations)
- **KDoc**: Required for all public APIs
- **String Resources**: Add new strings to `:ui` module (`ui/src/main/res/values/strings.xml`). Use typographic quotes/apostrophes (`"` `"` `'`) not escaped ASCII (`\"` `\'`)
- **String Resources**: Add new strings to `:ui` module (`ui/src/main/res/values/strings.xml`). Use typographic quotes/apostrophes (`"` `"` `'`) not escaped ASCII (`\"` `\'`). Name each resource from its own text content in `snake_case` — not with generic suffixes (`_message`, `_title`). E.g., `one_or_more_email_addresses_are_incorrect`, not `invalid_email_addresses_message`.
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.

🌱 Not requesting changes now, but let's keep an eye on this section. If it gets any larger we should consider extracting the rules into an appropriate skill (implementing-android-code or a new modifying-string-resources skill) and/or moving them to STYLE_AND_BEST_PRACTICES.md. There are no String Resource rules in STYLE_AND_BEST_PRACTICES.md, so that may be why it's not following our convention in the first place.

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Claude actually wanted to add it to the STYLE_AND_BEST_PRACTICES.md.

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.

In that case, let go ahead and move it. If we see Claude still "misbehaving" we can move it back into CLAUDE.md or a skill.

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.

Ha. I was too slow. 😆

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

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

Will open a new PR with it

@aj-rosado aj-rosado added this pull request to the merge queue Apr 30, 2026
Merged via the queue into main with commit d67d05e Apr 30, 2026
49 of 52 checks passed
@aj-rosado aj-rosado deleted the llm/improve-string-resources-claude-md branch April 30, 2026 17:44
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review-vnext Request a Claude code review using the vNext workflow t:llm Change Type - LLM related change (e.g. CLAUDE.md files)

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants