diff --git a/.editorconfig b/.editorconfig index cd8eb86..b26a9a9 100644 --- a/.editorconfig +++ b/.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 --git a/.gitattributes b/.gitattributes index 3286141..94de85c 100644 --- a/.gitattributes +++ b/.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 \ No newline at end of file diff --git a/CODE_OF_CONDUCT.md b/.github/CODE_OF_CONDUCT.md similarity index 92% rename from CODE_OF_CONDUCT.md rename to .github/CODE_OF_CONDUCT.md index 8e85f73..7c78703 100644 --- a/CODE_OF_CONDUCT.md +++ b/.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 `owzie123@gmail.com`. All +reported by contacting the project team at `development@pxgamer.xyz`. 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 --git a/CONTRIBUTING.md b/.github/CONTRIBUTING.md similarity index 60% rename from CONTRIBUTING.md rename to .github/CONTRIBUTING.md index 23508aa..2a987ca 100644 --- a/CONTRIBUTING.md +++ b/.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/yts). - ## 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 --git a/ISSUE_TEMPLATE.md b/.github/ISSUE_TEMPLATE.md similarity index 63% rename from ISSUE_TEMPLATE.md rename to .github/ISSUE_TEMPLATE.md index 5b48c57..544409e 100644 --- a/ISSUE_TEMPLATE.md +++ b/.github/ISSUE_TEMPLATE.md @@ -1,17 +1,11 @@ -## 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 --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..e11dfb6 --- /dev/null +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,23 @@ + + +## 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 --git a/.gitignore b/.gitignore index 073e37a..0cab348 100644 --- a/.gitignore +++ b/.gitignore @@ -1,3 +1,5 @@ -build -composer.lock -vendor +/build +/vendor +/composer.lock +/phpcs.xml +/phpunit.xml diff --git a/.travis.yml b/.travis.yml index d77bd4c..a965ca8 100644 --- a/.travis.yml +++ b/.travis.yml @@ -2,24 +2,25 @@ 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: - - travis_retry composer update --no-interaction --prefer-dist +- 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 --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md deleted file mode 100644 index 86246b3..0000000 --- a/PULL_REQUEST_TEMPLATE.md +++ /dev/null @@ -1,43 +0,0 @@ - - -## Description - -Describe your changes in detail. - -## Motivation and context - -Why is this change required? What problem does it solve? - -If it fixes an open issue, please link to the issue here (if you write `fixes #num` -or `closes #num`, the issue will be automatically closed when the pull is accepted.) - -## How has this been tested? - -Please describe in detail how you tested your changes. - -Include details of your testing environment, and the tests you ran to -see how your change affects other areas of the code, etc. - -## Screenshots (if appropriate) - -## Types of changes - -What types of changes does your code introduce? 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: - -Go over all the following points, and put an `x` in all the boxes that apply. - -Please, please, please, don't send your pull request until all of the boxes are ticked. Once your pull request is created, it will trigger a build on our [continuous integration](http://www.phptherightway.com/#continuous-integration) server to make sure your [tests and code style pass](https://help.github.com/articles/about-required-status-checks/). - -- [ ] 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. -- [ ] Each individual commit in the pull request is meaningful. -- [ ] I have added tests to cover my changes. -- [ ] If my change requires a change to the documentation, I have updated it accordingly. - -If you're unsure about any of these, don't hesitate to ask. We're here to help! diff --git a/README.md b/README.md index 66328f3..beb7df6 100644 --- a/README.md +++ b/README.md @@ -9,19 +9,11 @@ A full wrapper for the YTS API. -## Structure - -``` -src/ -tests/ -vendor/ -``` - ## Install Via Composer -``` bash +```bash $ composer require pxgamer/yts ``` @@ -72,17 +64,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 owzie123@gmail.com instead of using the issue tracker. +If you discover any security related issues, please email security@pxgamer.xyz instead of using the issue tracker. ## Credits diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 0000000..2990eca --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,14 @@ + + + The coding standard of yts package + + + + + + + + + + + diff --git a/phpunit.xml.dist b/phpunit.xml.dist index ae25de7..5513f43 100644 --- a/phpunit.xml.dist +++ b/phpunit.xml.dist @@ -20,9 +20,8 @@ - - +