Skip to content

Commit 760c7d5

Browse files
committed
Corrects some info in the Development section of readme
1 parent 76cabf4 commit 760c7d5

File tree

1 file changed

+7
-3
lines changed

1 file changed

+7
-3
lines changed

README.md

Lines changed: 7 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -102,7 +102,9 @@ New features are always welcome! Follow these guidelines
102102
- Make sure there is a way to test the feature.
103103
- Test with PHP 5.3 (I'm serious!), >=5.4<7, 7.current. Docker is helpful, particularly for the older versions. Just run the ubuntu:12.04 image and install php for 5.3 and 14.04 for 5.6. I can help if you're having trouble.
104104

105-
To run using the test data simply point the `--to` and `--from` args at the lock files,
105+
The `Makefile` has some test cases. Run `make | less` and inspect the output. If you need specific versions or more information, continue reading.
106+
107+
To run using the test data manually simply point the `--to` and `--from` args at the lock files,
106108

107109
```php
108110
php ./composer-lock-diff --from ./test-data/composer.from.lock --to ./test-data/composer.to.lock
@@ -149,9 +151,9 @@ Add a test case to test-data/
149151
- Copy `../test-data/composer.from.json` as `composer.json` and `../test-data/composer.from.lock` as `composer.lock`.
150152
- Commit them.
151153
- Run `composer install`
152-
- The generated `composer.lock` should look similar to `../test-data/composer.from.lock` but there will be differences due to transient dependencies. No real way around that. Use `composer-lock-diff` to make sure none of the named packages change versions.
153154
- Add your _pre_ case to `composer.json`. Use an exact version.
154-
- Generate a new lock file. Commit it.
155+
- Run `composer update`.
156+
- The generated `composer.lock` should look similar to `../test-data/composer.from.lock` but there will be differences due to transient dependencies. No real way around that. Use `composer-lock-diff` to make sure none of the named packages change versions and your new case is there.
155157
- Copy `composer.json` to `../test-data/composer.from.json` and `composer.lock` to `composer.from.lock`.
156158
- Copy `../test-data/composer.to.json` as `composer.json`.
157159
- Add your _post_ case to `composer.json`. Again, exact versions are best.
@@ -162,6 +164,8 @@ Add a test case to test-data/
162164
Test Cases
163165
----------
164166

167+
See `Makefile`
168+
165169
- `comopser-lock-diff` # no args
166170
- `composer-lock-diff --from ./test-data/composer.from.lock --to ./test-data/composer.to.lock`
167171
- `composer-lock-diff --path ./test-data/`

0 commit comments

Comments
 (0)