Repository navigation
docs: add composer create-project as a way to start - #41
Merged
Merged
Conversation
Packagist serves the starter as rtcamp/plugin-elementary, so a new project can start from a Composer download without the starter's Git history. The guide pairs it with --no-install and a first commit, so the dependency and init steps that follow stay the same.
The walkthrough keeps the Acme demo name, so its derived names still line up; the README quick start reads better with a placeholder.
Drop --no-install so the command matches the usual Composer form.
AnuragVasanwala
approved these changes
Oct 1, 2026
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.
Adds
composer create-projectas a way to start a plugin, next togit clone. Oncertcamp/plugin-elementaryis on Packagist, this gives a new project the skeleton without its Git history.Changes
README.md: the create-project command under Get started, with a generic folder name (my-plugin). The walkthrough keeps the Acme demo name so its derived names line up.docs/getting-started.md, step 1: the Composer route first, then the clone route.create-projectalso runscomposer install; step 2'snpm installis still needed.git initand a first commit give the copy a baseline to review init's changes against. A Composer download has no.git,npm run init -- --yesskips init's optional Git setup, andnpm installonly installs the Git hooks inside a repository.Before merging
create-projectinstalls the latest stable version, and the repository has no tags yet, so the command fails until v1.0.0 is tagged. Merge this after the v1.0.0 tag and the Packagist submission.Testing
Followed the new step 1 from an empty folder, downloading from GitHub with the same VCS driver Packagist uses (
--prefer-dist, the zip a release serves):composer create-project: a complete skeleton with no.gitnpm install, thennpm run init -- --name="Acme Content" --version=1.0.0 --yes --keep-examples: passesgit init,wp-tooling install-hooks(run bynpm install) installs thecommit-msgandpre-commithooks