Skip to content

PM-45227 - Point Seeder CLAUDE.md at the contributing site Seeder page - #8657

Merged
theMickster merged 3 commits into
mainfrom
seeder/PM-45227-contributing-docs-reminder
Oct 23, 2026
Merged

theMickster merged 3 commits into
mainfrom
seeder/PM-45227-contributing-docs-reminder

Conversation

@theMickster

@theMickster theMickster commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

🎟️ Tracking

PM-45227

📔 Objective

Docs only, three lines in the Seeder agent guidance. The contributing site now has a Seeder page
(bitwarden/contributing-docs#896) that
links down to the Seeder READMEs, presets, and scenarios. Nothing here pointed back, so a change
to commands, flags, or entry points could leave that page stale.

  • Review reminder - when util/Seeder, util/SeederUtility, or util/SeederApi change,
    Claude reminds the engineer to review the site page and its diagram
  • Stale handling - if the page is stale and the fix is out of scope, file a work item and add a
    stale marker per the documentation standard
  • File relationships - the site page is listed as the top-level entry point above the
    server-repo docs

The site's Seeder page links down to the Seeder docs, but nothing here
pointed back. Add a rule to review that page when Seeder code or docs
change, and list it in the file relationships map.
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

Claude Code validation

Result: Pass

This changeset adds three lines to util/Seeder/CLAUDE.md (214, 215, 222) pointing maintainers at the Seeder page on contributing.bitwarden.com. The secret scan found nothing on the added lines, every repo-relative path they reference resolves on disk (util/Seeder, util/SeederUtility, util/SeederApi, util/SeederApi/README.md, util/SeederUtility/README.md, util/Seeder/Seeds/docs/presets.md, util/Seeder/Seeds/docs/scenarios/), and no directive loosens the harness. One clarity issue carried over from the previous run still stands.

Not covered: The external link on line 214 (https://contributing.bitwarden.com/getting-started/server/seeder) was not verified to resolve — WebFetch permission was not granted in this run, the same as the previous run.

Findings
  • 🎨 SUGGESTED: Finding 1: Line 215 cites "the documentation standard", a "work item", and a "stale marker" that are defined nowhere in this repository, so the directive cannot be followed. (util/Seeder/CLAUDE.md:215)

    Details and fix

    The new bullet reads:

    • If that page is stale and the fix is not part of the same change, file a work item and add a stale marker to the page, per the documentation standard

    Three of its terms have no referent a reader or an agent can resolve. A case-insensitive search for documentation standard, stale marker, and work item across the repository matches only this line, so the standard it defers to is not reachable from here. "File a work item" names no tracker, and "add a stale marker" names no format. The page itself lives in bitwarden/contributing-docs, which is not checked out alongside this repo, so the one concrete action the line asks for targets a working tree that is not present.

    The neighbouring bullets in this same section are specific by contrast ("link to SeederUtility/README.md", "scan all *.md files under Seeds/ and SeederUtility/"), which is what makes this one stand out: it is re-read on every turn scoped to util/Seeder and cannot be acted on differently from its absence.

    Give the three terms referents — a link to the standard, and the tracker the work item goes to:

    - If that page is stale and the fix is not part of the same change, open a Jira ticket and add the stale marker described in https://contributing.bitwarden.com/contributing/documentation/ to the page in `bitwarden/contributing-docs`

    Substitute the real standard URL and tracker if they differ; the point is that each of the three terms resolves to something the reader can open.

    Reference: https://code.claude.com/docs/en/memory

@theMickster theMickster added the ai-review Request a Claude code review label Oct 21, 2026
@theMickster
theMickster marked this pull request as ready for review October 21, 2026 09:10
@github-actions

github-actions Bot commented Oct 21, 2026 •

Copy link
Copy Markdown
Contributor

🤖 Bitwarden Claude Code Review

Overall Assessment: APPROVE

This PR changes no code. It adds three lines of agent guidance to util/Seeder/CLAUDE.md, pointing at the Seeder page on contributing.bitwarden.com: a reminder to review that page when Seeder commands, flags, entry points, or docs change, instructions for when the page is stale, and a new entry in the file-relationships list. All four in-repo paths the new lines name exist on disk: SeederUtility/README.md, SeederApi/README.md, Seeds/docs/presets.md, and Seeds/docs/scenarios/. The Claude configuration check of the added lines found no credentials, no sensitive paths, and nothing that loosens the harness.

@theMickster theMickster added the t:misc Change Type - ¯\_(ツ)_/¯ Prefer using other type labels label Oct 21, 2026
@codecov

codecov Bot commented Oct 21, 2026 •

Copy link
Copy Markdown

Codecov Report

✅ All modified and coverable lines are covered by tests.
✅ Project coverage is 67.35%. Comparing base (9ef6853) to head (789c2c4).
⚠️ Report is 1 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main    #8657   +/-   ##
=======================================
  Coverage   67.34%   67.35%           
=======================================
  Files        2693     2693           
  Lines      115235   115235           
  Branches    10453    10453           
=======================================
+ Hits        77610    77611    +1     
+ Misses      35108    35107    -1     
  Partials     2517     2517           

☔ View full report in Codecov by Harness.
📢 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.
  • 📦 JS Bundle Analysis: Save yourself from yourself by tracking and limiting bundle sizes in JS merges.

@theMickster
theMickster merged commit ec55357 into main Oct 23, 2026
45 checks passed
@theMickster
theMickster deleted the seeder/PM-45227-contributing-docs-reminder branch October 23, 2026 16:56
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

ai-review Request a Claude code review t:misc Change Type - ¯\_(ツ)_/¯ Prefer using other type labels

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants