Merge pull request #21 from storyblok/add-changelog

Changelog

CHANGELOG.md

@@ -0,0 +1,16 @@
+# Changelog
+
+## 2.1.0 - 2023-01-23
+Release: [v2.1.0](https://github.com/storyblok/storyblok-php-richtext-renderer/releases/tag/2.1.0)
+
+### Added (new features)
+- Add Code Style Standards checker/fixer
+- GitHub Actions workflow for testing and checking the Coding Standards
+
+### Changed (fix/improvements)
+- Fix and cover more use cases with custom link attributes. Fixed issue #14 thanks to @uuf6429
+- General improvements in the codebase (adding .gitattributes file, adjusting .gitignore file,  using autoload psr-4 instead of psr-0...). The Pull Request with the changes in the #13 PR, thanks to @uuf6429
+
+
+## 2.0.0 - 2022-12-15
+Release: [v2.0.0](https://github.com/storyblok/storyblok-php-richtext-renderer/releases/tag/2.0.0)

README.md

@@ -67,7 +67,7 @@ $resolver = new Resolver($my_custom_schema);
 
 ## Testing
 
-We use phpunit for tests. You can execute the following task to run the tests:
+We use PHPUnit for tests. You can execute the following composer task to run the tests:
 
 ```bash
 composer run test
@@ -80,6 +80,29 @@ composer run test-coverage
 ```
 You will find the HTML reports in the `coverage/` directory.
 
+
+## Code Style guide
+
+For consistency, we are using [PHP Coding Standards Fixer](https://github.com/PHP-CS-Fixer/PHP-CS-Fixer) tool, for checking and fixing the code to follow standards.
+
+For checking the code you can execute:
+
+```
+composer run codestyle-check
+```
+
+If you want to automatically fix the code to follow standards:
+
+```
+composer run codestyle-fix
+```
+
+If you want to execute fix and test coverage:
+```
+composer run all-check
+```
+
+
 ## Contribution
 
 Fork me on [Github](https://github.com/storyblok/storyblok-php-richtext-renderer)

phpunit.xml.dist

@@ -1,18 +1,16 @@
 <?xml version="1.0" encoding="UTF-8"?>
-<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
-         xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/8.5/phpunit.xsd"
-         bootstrap="./vendor/autoload.php">
-    <php>
-        <ini name="error_reporting" value="-1"/>
-    </php>
-    <testsuites>
-        <testsuite name="All Tests">
-            <directory>./tests</directory>
-        </testsuite>
-    </testsuites>
-    <filter>
-        <whitelist>
-            <directory suffix=".php">./src</directory>
-        </whitelist>
-    </filter>
+<phpunit xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="https://schema.phpunit.de/9.3/phpunit.xsd" bootstrap="./vendor/autoload.php">
+  <coverage>
+    <include>
+      <directory suffix=".php">./src</directory>
+    </include>
+  </coverage>
+  <php>
+    <ini name="error_reporting" value="-1"/>
+  </php>
+  <testsuites>
+    <testsuite name="All Tests">
+      <directory>./tests</directory>
+    </testsuite>
+  </testsuites>
 </phpunit>