Skip to content

Commit

Permalink
update changelog and readme
Browse files Browse the repository at this point in the history
  • Loading branch information
patrick-blom committed Nov 16, 2019
1 parent 5c664d1 commit 6c9e0bf
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 0 deletions.
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,3 +1,12 @@
## [0.0.5] - 2019-11-14
### Added
- Add new exception for mutation testing
- Add mutation testing with infection
- Add new unit test for UriManager
### Changed
- Increase the quality of several tests
- Edit the README.md

## [0.0.4] - 2019-09-24
### Added
- Add the possibility to delete a created short link
Expand Down
11 changes: 11 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -119,6 +119,7 @@ are your authorization tokens. So please keep the following recommendations in m
- always use HTTPS, if you can

## Testing
### Regular Testing
If you want to test Shorty you can this by simply run a regular
`composer install` and `composer test` in the project root. This will
install all the dev dependencies and runs the test suite consisting of
Expand All @@ -131,3 +132,13 @@ commands separately:
- composer phpmd
- composer phpcs
- composer phpunit

### Mutation Testing
To keep the quality of the tests high, Shorty uses mutation testing.
The testing tool will be installed with composer dev dependencies. To
execute the mutation tests you can simply run:

- ./vendor/bin/infection

If you're not familiar with mutation testing checkout the
[infection](https://infection.github.io/guide/) page for more informations.

0 comments on commit 6c9e0bf

Please sign in to comment.