docs: Update README.md to reflect project structure and branding inte…#372
Open
Abhishekfm wants to merge 1 commit into
Open
docs: Update README.md to reflect project structure and branding inte…#372Abhishekfm wants to merge 1 commit into
Abhishekfm wants to merge 1 commit into
Conversation
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
1 participant
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
Rewrites the README for contributor-friendly guide: quick start, env vars, an explanation of the branding plugin model (stub vs. real-branding, where new code belongs), the full list of npm scripts, and a project-structure tree. README-only change.
Merge timing
we will hold until the branding repo transfers are complete — the README links to those repos and the URLs may shift during transfer.
Review
Hi @jpmckinney, Could you please take a look? The main thing I want your opinion on: is this the right way to contribute? Specifically the "How the branding plugin works" section — does the stub-vs-real-branding explanation land for someone with zero prior context?