diff --git a/CHANGELOG.md b/CHANGELOG.md index 26f0c90..1012540 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,9 +1,9 @@ -# Change Log +# Changelog All notable changes to this project will be documented in this file. -The format is based on [Keep a Changelog](http://keepachangelog.com/) and this project adheres -to [Semantic Versioning](http://semver.org). +The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/), +and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html). ## [Unreleased] @@ -88,7 +88,7 @@ to [Semantic Versioning](http://semver.org). monitoring station doesn't measure these. - Minimum requirement for PHP to 7.1.0 - Updated package versions for PHPStan, Mockery and PHPUnit. -- Updated inline documentation (various). +- Updated in-line documentation (various). ### Fixed @@ -97,18 +97,14 @@ to [Semantic Versioning](http://semver.org). ### Removed - Removed type casting as variables are already of proper data type. -- Removed invalid syntaxCheck parameter from the PHPUnit XML configuration. +- Removed invalid `syntaxCheck` parameter from the PHPUnit XML configuration. ## [1.0.0] 2017-02-15 - Initial release [Unreleased]: https://github.com/azuyalabs/waqi/compare/1.2.0...HEAD - [1.2.0]: https://github.com/azuyalabs/waqi/compare/1.1.0...1.2.0 - [1.1.0]: https://github.com/azuyalabs/waqi/compare/1.0.1...1.1.0 - [1.0.1]: https://github.com/azuyalabs/waqi/compare/1.0.0...1.0.1 - [1.0.0]: https://github.com/azuyalabs/waqi/releases/tag/1.0.0 diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 1037943..2e2b552 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -10,8 +10,8 @@ When contributing there are a few guidelines I would like you to keep in mind: - **[PSR-12 Coding Standard](https://www.php-fig.org/psr/psr-12/)** Please use the following command after you have completed your work: - ``` bash - $ composer format + ```shell + composer format ``` This will check/correct all the code for the PSR-12 Coding Standard using the @@ -31,12 +31,12 @@ When contributing there are a few guidelines I would like you to keep in mind: ## Running Tests -``` bash -$ composer test +```shell +composer test ``` -or alternatively run with: +,or alternatively run with: -``` bash -$ vendor/bin/phpunit +```shell +vendor/bin/phpunit ``` diff --git a/SECURITY.md b/SECURITY.md index b99282e..cf33ea5 100644 --- a/SECURITY.md +++ b/SECURITY.md @@ -11,7 +11,7 @@ Please refer to the below table for the supported versions of this project. | < 1.0 | :x: | As for supported PHP versions, this project only supports the actively supported versions of PHP. Currently, that is PHP -8.1 and 8.2. Please refer to the [supported versions](https://www.php.net/supported-versions.php) page, to find +8.2 and 8.3. Please refer to the [supported versions](https://www.php.net/supported-versions.php) page, to find more details. When a version of PHP becomes EOL, generally a new release of this project will be issued that sunsets the support of that retired PHP version.