Merge branch 'feature/directory-structure' into develop

Author: owenvoke

Diff for: .editorconfig

@@ -1,5 +1,5 @@
 ; This file is for unifying the coding style for different editors and IDEs.
-; More information at http://editorconfig.org
+; More information at https://editorconfig.org
 
 root = true
 

Diff for: .gitattributes

@@ -1,11 +1,16 @@
+* text=auto
+
 # Path-based git attributes
 # https://www.kernel.org/pub/software/scm/git/docs/gitattributes.html
 
 # Ignore all test and documentation with "export-ignore".
+/.editorconfig      export-ignore
 /.gitattributes     export-ignore
+/.github            export-ignore
 /.gitignore         export-ignore
+/.styleci.yml       export-ignore
 /.travis.yml        export-ignore
+/docs               export-ignore
+/phpcs.xml.dist     export-ignore
 /phpunit.xml.dist   export-ignore
-/.scrutinizer.yml   export-ignore
 /tests              export-ignore
-/docs               export-ignore

Diff for: CODE_OF_CONDUCT.md renamed to .github/CODE_OF_CONDUCT.md

@@ -55,7 +55,7 @@ further defined and clarified by project maintainers.
 ## Enforcement
 
 Instances of abusive, harassing, or otherwise unacceptable behavior may be
-reported by contacting the project team at `[email protected]`. All
+reported by contacting the project team at `[email protected]`. All
 complaints will be reviewed and investigated and will result in a response that
 is deemed necessary and appropriate to the circumstances. The project team is
 obligated to maintain confidentiality with regard to the reporter of an incident.
@@ -68,7 +68,7 @@ members of the project's leadership.
 ## Attribution
 
 This Code of Conduct is adapted from the [Contributor Covenant][homepage], version 1.4,
-available at [http://contributor-covenant.org/version/1/4][version]
+available at [https://contributor-covenant.org/version/1/4][version]
 
-[homepage]: http://contributor-covenant.org
-[version]: http://contributor-covenant.org/version/1/4/
+[homepage]: https://contributor-covenant.org
+[version]: https://contributor-covenant.org/version/1/4

Diff for: CONTRIBUTING.md renamed to .github/CONTRIBUTING.md

@@ -4,29 +4,16 @@ Contributions are **welcome** and will be fully **credited**.
 
 We accept contributions via Pull Requests on [Github](https://github.com/pxgamer/php-json-g).
 
-
 ## Pull Requests
 
 - **[PSR-2 Coding Standard](https://github.com/php-fig/fig-standards/blob/master/accepted/PSR-2-coding-style-guide.md)** - Check the code style with ``$ composer check-style`` and fix it with ``$ composer fix-style``.
 
-- **Add tests!** - Your patch won't be accepted if it doesn't have tests.
+- **Add tests!** - If possible, try to add tests to support your patch.
 
 - **Document any change in behaviour** - Make sure the `README.md` and any other relevant documentation are kept up-to-date.
 
-- **Consider our release cycle** - We try to follow [SemVer v2.0.0](http://semver.org/). Randomly breaking public APIs is not an option.
+- **Consider our release cycle** - We try to follow [SemVer v2.0.0](https://semver.org). Randomly breaking public APIs is not an option.
 
 - **Create feature branches** - Don't ask us to pull from your master branch.
 
 - **One pull request per feature** - If you want to do more than one thing, send multiple pull requests.
-
-- **Send coherent history** - Make sure each individual commit in your pull request is meaningful. If you had to make multiple intermediate commits while developing, please [squash them](http://www.git-scm.com/book/en/v2/Git-Tools-Rewriting-History#Changing-Multiple-Commit-Messages) before submitting.
-
-
-## Running Tests
-
-``` bash
-$ composer test
-```
-
-
-**Happy coding**!

Diff for: ISSUE_TEMPLATE.md renamed to .github/ISSUE_TEMPLATE.md

@@ -1,17 +1,11 @@
 <!-- Provide a general summary of the issue in the Title above -->
 
-## Detailed description
+## Description
 
 Provide a detailed description of the change or addition you are proposing.
 
 Make it clear if the issue is a bug, an enhancement or just a question.
 
-## Context
-
-Why is this change important to you? How would you use it?
-
-How can it benefit other users?
-
 ## Possible implementation
 
 Not obligatory, but suggest an idea for implementing addition or change.
@@ -20,8 +14,6 @@ Not obligatory, but suggest an idea for implementing addition or change.
 
 Include as many relevant details about the environment you experienced the bug in and how to reproduce it.
 
-* Version used (e.g. PHP 5.6, HHVM 3):
-* Operating system and version (e.g. Ubuntu 16.04, Windows 7):
-* Link to your project:
-* ...
+* Version used (e.g. PHP 7.3):
+* Operating system and version (e.g. Ubuntu 18.10, Windows 10):
 * ...

Diff for: .github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+<!--- Provide a general summary of your changes in the Title above -->
+
+## Description
+
+...
+
+## Types of changes
+
+Put an `x` in all the boxes that apply:
+
+- [ ] Bug fix (non-breaking change which fixes an issue)
+- [ ] New feature (non-breaking change which adds functionality)
+- [ ] Breaking change (fix or feature that would cause existing functionality to change)
+
+## Checklist
+
+Put an `x` in all the boxes that apply:
+
+- [ ] I have read the **[CONTRIBUTING](CONTRIBUTING.md)** document.
+- [ ] My pull request addresses exactly one patch/feature.
+- [ ] I have created a branch for this patch/feature.
+
+If you're unsure about any of these, don't hesitate to ask. We're here to help!

Diff for: .gitignore

@@ -1,3 +1,5 @@
-build
-composer.lock
-vendor
+/build
+/vendor
+/composer.lock
+/phpcs.xml
+/phpunit.xml

Diff for: .travis.yml

@@ -2,26 +2,27 @@ dist: trusty
 language: php
 
 php:
-  - 7.1
-  - nightly
+- 7.2
+- 7.3
+- nightly
 
-# This triggers builds to run on the new TravisCI infrastructure.
-# See: http://docs.travis-ci.com/user/workers/container-based-infrastructure/
-sudo: false
+matrix:
+    allow_failures:
+    - php: nightly
 
 ## Cache composer
 cache:
-  directories:
+    directories:
     - $HOME/.composer/cache
 
 before_script:
-  - pecl channel-update pecl.php.net
-  - printf "\n" | pecl install imagick
-  - travis_retry composer update --no-interaction --prefer-dist
+- pecl channel-update pecl.php.net
+- printf "\n" | pecl install imagick
+- travis_retry composer update --no-interaction --prefer-dist
 
 script:
-  - vendor/bin/phpcs --standard=psr2 src/
-  - vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
+- vendor/bin/phpcs --standard=psr2 src/
+- vendor/bin/phpunit --coverage-text --coverage-clover=coverage.clover
 
 after_success:
-  - bash <(curl -s https://codecov.io/bash)
+- bash <(curl -s https://codecov.io/bash)

Diff for: PULL_REQUEST_TEMPLATE.md

@@ -9,20 +9,11 @@
 
 A PHP implementation of [JSON-G](https://github.com/Roadcrosser/JSON-G).
 
-## Structure
-
-```
-resources/
-src/
-tests/
-vendor/
-```
-
 ## Install
 
 Via Composer
 
-``` bash
+```bash
 $ composer require pxgamer/json-g
 ```
 
@@ -33,6 +24,7 @@ Use the `JsonG::toImageBlob()` or `JsonG::toJson()` to convert between a blob an
 #### Examples
 
 **Converting an image via POST**
+
 ```php
 $base64 = base64_decode($_POST['in']);
 
@@ -46,6 +38,7 @@ echo $json;
 ```
 
 **Converting a JSON-G string to image via POST**
+
 ```php
 $jsonArray = json_decode($_POST['in'], true);
 
@@ -61,17 +54,17 @@ Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed re
 
 ## Testing
 
-``` bash
+```bash
 $ composer test
 ```
 
 ## Contributing
 
-Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details.
+Please see [CONTRIBUTING](.github/CONTRIBUTING.md) and [CODE_OF_CONDUCT](.github/CODE_OF_CONDUCT.md) for details.
 
 ## Security
 
-If you discover any security related issues, please email [email protected] instead of using the issue tracker.
+If you discover any security related issues, please email [email protected] instead of using the issue tracker.
 
 ## Credits
 
@@ -96,4 +89,4 @@ The MIT License (MIT). Please see [License File](LICENSE.md) for more informatio
 [link-code-quality]: https://codecov.io/gh/pxgamer/php-json-g
 [link-downloads]: https://packagist.org/packages/pxgamer/json-g
 [link-author]: https://github.com/pxgamer
-[link-contributors]: ../../contributors
+[link-contributors]: ../../contributors

Diff for: README.md

@@ -0,0 +1,14 @@
+<?xml version="1.0"?>
+<ruleset name="json-g">
+    <description>The coding standard of json-g package</description>
+    <arg value="p" />
+
+    <config name="ignore_warnings_on_exit" value="1" />
+    <config name="ignore_errors_on_exit" value="1" />
+
+    <arg name="colors" />
+    <arg value="s" />
+
+    <!-- Use the PSR2 Standard-->
+    <rule ref="PSR2" />
+</ruleset>

Diff for: phpcs.xml.dist

@@ -20,10 +20,9 @@
         </whitelist>
     </filter>
     <logging>
-        <log type="tap" target="build/report.tap"/>
         <log type="junit" target="build/report.junit.xml"/>
-        <log type="coverage-html" target="build/coverage" charset="UTF-8" yui="true" highlight="true"/>
+        <log type="coverage-html" target="build/coverage"/>
         <log type="coverage-text" target="build/coverage.txt"/>
         <log type="coverage-clover" target="build/logs/clover.xml"/>
     </logging>
-</phpunit>
+</phpunit>