Skip to content

Conversation

jscott-nava
Copy link
Contributor

🎫 Ticket

https://jira.cms.gov/browse/PLT-1108

🛠 Changes

This PR updates the web module README sample usage section with commit hashes instead of branch references now that the branch has been merged.

ℹ️ Context

The CDAP web module contains a sample usage snippet in the README that contains three references to the branch in which changes were being made. Since that branch has now been merged to main these references should now be updated to the commit hash of that merge.

🧪 Validation

This is a README update that does not require validation.

@jscott-nava jscott-nava requested a review from a team as a code owner September 29, 2025 15:58
@gsf
Copy link
Member

gsf commented Sep 29, 2025

For other READMEs, I've been moving toward a convention of <hash> for references to commits within this repo. That forces implementers to paste in a commit hash (likely the latest) instead of relying on a potentially out-of-date reference given that we currently have no automation for updating hashes in the READMEs. Examples:

@jscott-nava jscott-nava requested a review from gsf September 29, 2025 16:31
@jscott-nava jscott-nava merged commit 4c43bdd into main Oct 6, 2025
@jscott-nava jscott-nava deleted the jscott/PLT-1108_README_commit_hash_updates branch October 6, 2025 14:34
juliareynolds-nava pushed a commit that referenced this pull request Oct 7, 2025
#319)

## 🎫 Ticket

https://jira.cms.gov/browse/PLT-1108

## 🛠 Changes

This PR updates the web module README sample usage section with commit
hashes instead of branch references now that the branch has been merged.

## ℹ️ Context

The CDAP web module contains a sample usage snippet in the README that
contains three references to the branch in which changes were being
made. Since that branch has now been merged to main these references
should now be updated to the commit hash of that merge.

## 🧪 Validation

This is a README update that does not require validation.
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.

3 participants