test-coverage-badge on workflow_dispatch

Author: medilies

.github/workflows/test-coverage-badge.yml

@@ -1,10 +1,6 @@
 name: test-coverage-badge
 
-on:
-  push:
-    branches: [main]
-  pull_request:
-    branches: [main]
+on: workflow_dispatch
 
 jobs:
   test:
@@ -36,6 +32,9 @@ jobs:
       - name: Generate test coverage badge
         uses: timkrase/phpunit-coverage-badge@v1.2.0
         with:
-          coverage_badge_path: 'badge-coverage.svg'
+          coverage_badge_path: "badge-coverage.svg"
           push_badge: true
           repo_token: ${{ secrets.GITHUB_TOKEN }}
+
+      - name: remove clover.xml
+        run: rm clover.xml

CONTRIBUTING.md

@@ -0,0 +1,19 @@
+# CONTRIBUTING
+
+All PRs are welcomed :)
+
+## Coding Style
+
+PHP JSON tongue follows the `PSR-2` coding standard and the `PSR-4` autoloading standard.
+
+## PHPDoc
+
+PHPDoc blocs aren't required, but type hinting is required when possible.
+
+## Pint
+
+```
+./vendor/bin/pint
+```
+
+Don't worry if your code styling isn't perfect! `Fix PHP code style issues` action will automatically merge any style fixes into the PHP JSON tongue repository after pull requests are merged. This allows us to focus on the content of the contribution and not the code style.

LICENCE LICENSE.mdLICENCE renamed to LICENSE.md

@@ -52,3 +52,21 @@ $localization = [
     //...
 ];
 ```
+
+## Testing
+
+```bash
+vendor/bin/pest
+```
+
+## Changelog
+
+<!-- Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. -->
+
+## Contributing
+
+Please see [CONTRIBUTING](CONTRIBUTING.md) for details.
+
+## License
+
+The MIT License (MIT). Please see [License File](LICENSE.md) for more information.

README.md

@@ -3,7 +3,7 @@
 use ElaborateCode\JsonTongue\Tests\JsonFaker\JsonFaker;
 use ElaborateCode\JsonTongue\TongueFacade;
 
-it('complete')
+it('trascribes')
     ->expect(function () {
         $this->jsonFaker = JsonFaker::make()
             ->addLocale('ar', [