Skip to content

[PM-37940] Update guidance on field keys and authoring map major version changes#19

Merged
jprusik merged 3 commits into
mainfrom
pm-37940
May 26, 2026
Merged

[PM-37940] Update guidance on field keys and authoring map major version changes#19
jprusik merged 3 commits into
mainfrom
pm-37940

Conversation

@jprusik

@jprusik jprusik commented May 22, 2026

Copy link
Copy Markdown
Collaborator

🎟️ Tracking

PM-37940

📔 Objective

Update guidance on field keys and authoring map major version changes

Additional context:
#18 (comment)
#11 (comment)

@jprusik jprusik self-assigned this May 22, 2026
@jprusik jprusik added the ai-review-vnext Request a Claude code review using the vNext workflow label May 22, 2026
@jprusik jprusik changed the title Pm 37940 [PM-37940] Update guidance on field keys and authoring map major version changes May 22, 2026
@github-actions

github-actions Bot commented May 22, 2026

Copy link
Copy Markdown

Bitwarden Claude Code Review

Overall Assessment: APPROVE

This PR adds an "Authoring Maps → Major Version Bumps" section to the root README documenting the cross-Map workflow for shipping a new major schema alongside the previous one, consolidates the Forms Map field key reference into a single combined table with clarifying prose on role/input semantics, and adds two fail-fast build invariants in scripts/build.mjs (schema filename major must agree with properties.schemaVersion.const major, and $id must end with the schema filename). Verified the documented workflow matches the existing build/release behavior, the 43-entry consolidated field key table is in lockstep with the fieldKey enum in forms.v0.schema.json, all referenced anchors (#schema-versions, #prerelease-maps, #backwards-compatibility, #mapping-philosophies) exist in the README, and the TOC anchor fix raised by @bensbits91 was applied in commit f63383e. No new findings.

Code Review Details

No findings.

@jprusik jprusik marked this pull request as ready for review May 22, 2026 15:31
@jprusik jprusik requested a review from a team as a code owner May 22, 2026 15:31
@jprusik jprusik requested a review from bensbits91 May 22, 2026 15:31
Comment thread maps/forms/README.md

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

Real world example which informed these changes and clarifications:

Image

@bensbits91 bensbits91 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.

One minor issue with readme TOC after changing headings. Looks good otherwise

Comment thread maps/forms/README.md
Note, a field described by the `username` key is not exclusive to
authentication concerns, and may be represented in other form categories.

#### Names

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.

TOC needs to be updated to fix broken links after changing headings. In the TOC, around lines 40-42

Old:

      - [Name](#name)
      - [Contact](#contact)
      - [Address](#address)

New:

      - [Names](#names)
      - [Contacts](#contacts)
      - [Addresses](#addresses)

Copy link
Copy Markdown
Collaborator Author

Choose a reason for hiding this comment

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

ooo, nice catch - fixed in f63383e

@jprusik jprusik requested a review from bensbits91 May 26, 2026 18:13
@jprusik jprusik merged commit ecd8b87 into main May 26, 2026
16 checks passed
@jprusik jprusik deleted the pm-37940 branch May 26, 2026 18:56
@jprusik jprusik mentioned this pull request Jun 25, 2026
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

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants