Skip to content

Update ReadMe#29

Merged
kieran-osgood-shopify merged 1 commit into
mainfrom
kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme
May 11, 2026
Merged

Update ReadMe#29
kieran-osgood-shopify merged 1 commit into
mainfrom
kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme

Conversation

@kieran-osgood-shopify

@kieran-osgood-shopify kieran-osgood-shopify commented May 8, 2026

Copy link
Copy Markdown
Contributor

What changes are you making?

You can view it visually here, I've moved the Ai Quickstart on skills section up the stack though
https://github.com/shopify-playground/checkout-kit/blob/eee6f56e98ff400c758042028382d24e4165930b/README.md

I've been thinking about making the repo more "AI Native"

This PR aims to update the readme to recommend AI patterns, such as /skills and .local clones and AGENTS.md updates

In terms of skills the first two that come to mind are:

  • migration v3 -> v4 (e.g. how to move from the current event handlers to the new protocol client approach)
  • how to present/preload/invalidate checkout (this seems to be under utilised and misunderstood)

Another pattern I've seen used is 'reference repositories' - basically you clone the repo locally, and tell AI to read that instead of web search

Perhaps we can use the Shopify.dev docs to create a local dev docs reference in there so there is an efficient path for reading those too?

How to test


Before you merge

Important

  • I've added tests to support my implementation
  • I have read and agree with the Contribution Guidelines
  • I have read and agree with the Code of Conduct
  • I've updated the relevant platform README (swift/README.md and/or android/README.md)

Releasing a new Swift version?
  • I have bumped the version in swift/ShopifyCheckoutKit.podspec
  • I have bumped the version in swift/Sources/ShopifyCheckoutKit/ShopifyCheckoutKit.swift
  • I have updated swift/CHANGELOG.md
  • I have updated the SwiftPM/CocoaPods version snippets in swift/README.md (major version only)
Releasing a new Android version?
  • I have bumped the versionName in android/lib/build.gradle
  • I have updated android/CHANGELOG.md
  • I have updated the Gradle/Maven version snippets in android/README.md

Tip

See the Contributing documentation for the full release process per platform.

kieran-osgood-shopify commented May 8, 2026

Copy link
Copy Markdown
Contributor Author

This stack of pull requests is managed by Graphite. Learn more about stacking.

@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch 9 times, most recently from 6c22dd0 to eee6f56 Compare May 8, 2026 10:51
@kieran-osgood-shopify kieran-osgood-shopify changed the title feat(ReadMe/skills): add skills dir and refresh readme Add /skills for AI - Update ReadMe May 8, 2026
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch 5 times, most recently from ecefb9a to 56e06e3 Compare May 8, 2026 17:02
@kieran-osgood-shopify kieran-osgood-shopify changed the title Add /skills for AI - Update ReadMe Update ReadMe May 8, 2026
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch from 56e06e3 to d6340a0 Compare May 8, 2026 17:04
@kieran-osgood-shopify kieran-osgood-shopify mentioned this pull request May 8, 2026
11 tasks
@kieran-osgood-shopify kieran-osgood-shopify marked this pull request as ready for review May 8, 2026 17:06
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch from d6340a0 to c9dc00e Compare May 8, 2026 17:08
Comment thread README.md Outdated
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch from c9dc00e to 731d669 Compare May 11, 2026 08:16
@markmur markmur added the #gsd:50662 Rebase Checkout Kit on UCP label May 11, 2026
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch from 731d669 to 9c35a97 Compare May 11, 2026 15:54
@kieran-osgood-shopify kieran-osgood-shopify enabled auto-merge (squash) May 11, 2026 16:08
@kieran-osgood-shopify kieran-osgood-shopify force-pushed the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch from 9c35a97 to da4cbcd Compare May 11, 2026 17:05
@kieran-osgood-shopify kieran-osgood-shopify requested a review from a team as a code owner May 11, 2026 17:05
@kieran-osgood-shopify kieran-osgood-shopify merged commit e94799c into main May 11, 2026
11 checks passed

Copy link
Copy Markdown
Contributor Author

Merge activity

@kieran-osgood-shopify kieran-osgood-shopify deleted the kieran-osgood/05-08-featreadme/skillsaddskillsdirandrefreshreadme branch May 11, 2026 17:07
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

#gsd:50662 Rebase Checkout Kit on UCP

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants