Skip to content

Commit 5aba376

Browse files
committed
docs: add details to contributing guide for running wizard locally
1 parent 5737bf4 commit 5aba376

File tree

1 file changed

+13
-0
lines changed

1 file changed

+13
-0
lines changed

CONTRIBUTING.md

Lines changed: 13 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -169,6 +169,19 @@ composer test
169169
CaptainHook will automatically run all tests before pushing to the remote
170170
repository.
171171

172+
### Running `create-project` Locally
173+
174+
You can test Composer's `create-project` command locally to make sure the
175+
starter kit wizard runs properly with your changes. To do so, use a command
176+
similar to the following:
177+
178+
```shell
179+
composer create-project ramsey/php-library-starter-kit YOUR-PROJECT-NAME \
180+
--repository='{ "type": "path", "url": "/path/to/local/php-library-starter-kit", "options": { "symlink": false } }' \
181+
--remove-vcs \
182+
--stability=dev
183+
```
184+
172185
[github]: https://github.com/ramsey/php-library-starter-kit
173186
[issues]: https://github.com/ramsey/php-library-starter-kit/issues
174187
[pull requests]: https://github.com/ramsey/php-library-starter-kit/pulls

0 commit comments

Comments
 (0)