Align storefront README with the other components#6515
Open
kennyadsl wants to merge 2 commits into
Open
Conversation
The storefront README was carried over unchanged from the solidus_storefront repository merged in solidusio#6468, so it still presented the component as a standalone gem: a hero image and CI/codecov badges pointing at the old repository (the workflow badge even linked to a literal <WORKFLOW_FILE> placeholder), a compatibility section describing version branches of the old repo, a CI strategy section describing pipelines that no longer exist, and Security/About sections that the sibling components leave to the main README. Rewrite it following the structure of the other component READMEs (backend, admin, api): a short description, installation, and testing and development sections. The compatibility section now reflects how the installer actually resolves templates since the monorepo merge: released Solidus versions apply the templates from their corresponding vX.Y branch, prereleases from main. The development section bullets now match what docs/development.md actually covers. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
Now that the storefront lives in the main Solidus repository, the project-wide LICENSE.md applies to it like every other component. The storefront is not packaged as a gem, so nothing ships or references this file, and keeping a separate Nebulab-copyrighted license around would only create confusion about which terms apply. Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
github-actions
Bot
added
the
changelog:repository
Codecov Report✅ All modified and coverable lines are covered by tests. Additional details and impacted files@@ Coverage Diff @@
## main #6515 +/- ##
=======================================
Coverage 92.02% 92.02%
=======================================
Files 1035 1035
Lines 21125 21125
=======================================
Hits 19440 19440
Misses 1685 1685 ☔ View full report in Codecov by Harness. 🚀 New features to boost your workflow:
|
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
The storefront README came over verbatim from the
solidus_storefrontrepository when it was merged into the monorepo in #6468, so it still described the component as a standalone gem. Several links were broken or stale: the CI badge pointed at the old repository's workflows (with a literal<WORKFLOW_FILE>placeholder in the URL), the codecov badge tracked the old repo, and the compatibility and CI strategy sections described version branches and scheduled pipelines of a repository that is no longer where this code lives.This rewrites the README following the structure of the other component READMEs (backend, admin, api): a short description of what the component is, followed by installation, testing, and development sections. The compatibility section now describes how the installer actually resolves templates since the monorepo merge — released Solidus versions apply the templates from their corresponding
vX.Ybranch, prereleases frommain. The hero image, badges, and the Security/About sections are gone, since the sibling components leave that kind of project-level content to the main README. The development section bullets now match whatdocs/development.mdactually covers (running the sandbox and Docker development).It also removes
storefront/LICENSE: the storefront is not packaged as a gem, so nothing ships or references that file, and the project-wideLICENSE.mdapplies to it like every other component.🤖 Generated with Claude Code