Skip to content

Commit 1a0ba46

Browse files
committed
Update to README.md to add example output and current checks & ruleset.
1 parent 12e5d0a commit 1a0ba46

File tree

1 file changed

+18
-3
lines changed

1 file changed

+18
-3
lines changed

README.md

Lines changed: 18 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -16,19 +16,34 @@ After the inspection is completed, you are given a list of changes that have occ
1616
- Function added -> **MINOR**
1717
- Function removed -> **MAJOR**
1818
- Function parameter mismatch -> **MAJOR**
19+
- Function implementation changed -> **PATCH**
1920
- Classes
2021
- Class added -> **MINOR**
2122
- Class removed -> **MAJOR**
2223
- Class method added -> **MINOR**
2324
- Class method removed -> **MAJOR**
2425
- Class method parameter mismatch -> **MAJOR**
26+
- Class method implementation changed -> **PATCH**
2527

2628
## Example
2729

2830
```bash
29-
php bin/php-semver-checker compare --before-source before/ --after-source after/
30-
31-
31+
php bin/php-semver-checker compare --before-source laravel-4.2.15 --after-source laravel-4.2.16
32+
33+
Suggested semantic versioning change: MAJOR
34+
35+
CLASS
36+
LEVEL LOCATION REASON
37+
MAJOR src/Illuminate/Database/Eloquent/Model.php#2550 Illuminate/Database/Eloquent/Model::getMutatorMethod Method has been removed.
38+
PATCH src/Illuminate/Database/Eloquent/Model.php#243 __construct Method implementation changed.
39+
PATCH src/Illuminate/Database/Eloquent/Model.php#322 addGlobalScope Method implementation changed.
40+
PATCH src/Illuminate/Database/Eloquent/Model.php#333 hasGlobalScope Method implementation changed.
41+
PATCH src/Illuminate/Database/Eloquent/Model.php#344 getGlobalScope Method implementation changed.
42+
PATCH src/Illuminate/Database/Eloquent/Model.php#357 getGlobalScopes Method implementation changed.
43+
[... cut for brievity ...]
44+
45+
FUNCTION
46+
LEVEL LOCATION REASON
3247
```
3348

3449
## License

0 commit comments

Comments
 (0)