From 9c49b9ae2cb635abe55990f708374ca52875fb11 Mon Sep 17 00:00:00 2001 From: Andreas Warnaar Date: Fri, 15 Feb 2019 11:03:07 +0100 Subject: [PATCH 1/2] Skeleton proposition OS --- .gitignore | 1 + CHANGELOG.md | 22 ++++++++++++ CODE_OF_CONDUCT.md | 74 ++++++++++++++++++++++++++++++++++++++++ CONTRIBUTERS.md | 14 ++++++++ CONTRIBUTING.md | 32 +++++++++++++++++ ISSUE_TEMPLATE.md | 27 +++++++++++++++ LICENSE => LICENSE.md | 0 PULL_REQUEST_TEMPLATE.md | 43 +++++++++++++++++++++++ README.md | 65 +++++++++++++++++++++++++++++++++++ composer.json | 51 +++++++++++++++++++++++++++ phpcs.xml.dist | 14 ++++++++ phpunit.xml.dist | 28 +++++++++++++++ src/SkeletonClass.php | 28 +++++++++++++++ tests/ExampleTest.php | 16 +++++++++ 14 files changed, 415 insertions(+) create mode 100644 .gitignore create mode 100644 CHANGELOG.md create mode 100644 CODE_OF_CONDUCT.md create mode 100644 CONTRIBUTERS.md create mode 100644 CONTRIBUTING.md create mode 100644 ISSUE_TEMPLATE.md rename LICENSE => LICENSE.md (100%) create mode 100644 PULL_REQUEST_TEMPLATE.md create mode 100644 README.md create mode 100644 composer.json create mode 100644 phpcs.xml.dist create mode 100644 phpunit.xml.dist create mode 100644 src/SkeletonClass.php create mode 100644 tests/ExampleTest.php diff --git a/.gitignore b/.gitignore new file mode 100644 index 0000000..485dee6 --- /dev/null +++ b/.gitignore @@ -0,0 +1 @@ +.idea diff --git a/CHANGELOG.md b/CHANGELOG.md new file mode 100644 index 0000000..9520e32 --- /dev/null +++ b/CHANGELOG.md @@ -0,0 +1,22 @@ +# Changelog + +All notable changes to `kennisnet/phpECKS` will be documented in this file. + +Updates should follow the [Keep a CHANGELOG](http://keepachangelog.com/) principles. + +## NEXT - YYYY-MM-DD + +### Added +- Nothing + +### Deprecated +- Nothing + +### Fixed +- Nothing + +### Removed +- Nothing + +### Security +- Nothing diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..15a55b4 --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,74 @@ +# Contributor Code of Conduct + +## Our Pledge + +In the interest of fostering an open and welcoming environment, we as +contributors and maintainers pledge to make participation in our project and +our community a harassment-free experience for everyone, regardless of age, body +size, disability, ethnicity, gender identity and expression, level of experience, +nationality, personal appearance, race, religion, or sexual identity and +orientation. + +## Our Standards + +Examples of behavior that contributes to creating a positive environment +include: + +* Using welcoming and inclusive language +* Being respectful of differing viewpoints and experiences +* Gracefully accepting constructive criticism +* Focusing on what is best for the community +* Showing empathy towards other community members + +Examples of unacceptable behavior by participants include: + +* The use of sexualized language or imagery and unwelcome sexual attention or +advances +* Trolling, insulting/derogatory comments, and personal or political attacks +* Public or private harassment +* Publishing others' private information, such as a physical or electronic + address, without explicit permission +* Other conduct which could reasonably be considered inappropriate in a + professional setting + +## Our Responsibilities + +Project maintainers are responsible for clarifying the standards of acceptable +behavior and are expected to take appropriate and fair corrective action in +response to any instances of unacceptable behavior. + +Project maintainers have the right and responsibility to remove, edit, or +reject comments, commits, code, wiki edits, issues, and other contributions +that are not aligned to this Code of Conduct, or to ban temporarily or +permanently any contributor for other behaviors that they deem inappropriate, +threatening, offensive, or harmful. + +## Scope + +This Code of Conduct applies both within project spaces and in public spaces +when an individual is representing the project or its community. Examples of +representing a project or community include using an official project e-mail +address, posting via an official social media account, or acting as an appointed +representative at an online or offline event. Representation of a project may be +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 `mail@andreaswarnaar.nl`. 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. +Further details of specific enforcement policies may be posted separately. + +Project maintainers who do not follow or enforce the Code of Conduct in good +faith may face temporary or permanent repercussions as determined by other +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] + +[homepage]: http://contributor-covenant.org +[version]: http://contributor-covenant.org/version/1/4/ diff --git a/CONTRIBUTERS.md b/CONTRIBUTERS.md new file mode 100644 index 0000000..406e9ed --- /dev/null +++ b/CONTRIBUTERS.md @@ -0,0 +1,14 @@ +Note +==== +This file contains information about people who are permitted to make +changes to various parts of the code and associated libraries. + +Please do not contact the people in this file directly to report +problems in github.com/kennisnet/phpECKS + +Maintainers +=========== + +Global Reviewers +Andreas Warnaar + diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..ccd2776 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,32 @@ +# Contributing + +Contributions are **welcome** and will be fully **credited**. + +We accept contributions via Pull Requests on [Github](https://github.com/kennisnet/phpECKS). + + +## 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. + +- **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. + +- **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/ISSUE_TEMPLATE.md new file mode 100644 index 0000000..27dd613 --- /dev/null +++ b/ISSUE_TEMPLATE.md @@ -0,0 +1,27 @@ + + +## Detailed 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. + +## Your environment + +Include as many relevant details about the environment you experienced the bug in and how to reproduce it. + +* Version used (e.g. PHP 7.0.33): +* Operating system and version (e.g. Ubuntu 16.04, Windows 7): +* Link to your project: +* ... +* ... diff --git a/LICENSE b/LICENSE.md similarity index 100% rename from LICENSE rename to LICENSE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..86246b3 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,43 @@ + + +## 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 new file mode 100644 index 0000000..145ef6a --- /dev/null +++ b/README.md @@ -0,0 +1,65 @@ +# kennisnet/phpECKS + +[![Latest Version on Packagist][ico-version]][link-packagist] +[![Software License][ico-license]](LICENSE.md) +[![Build Status][ico-travis]][link-travis] +[![Coverage Status][ico-scrutinizer]][link-scrutinizer] +[![Quality Score][ico-code-quality]][link-code-quality] +[![Total Downloads][ico-downloads]][link-downloads] + +## Install + +Via Composer + +``` bash +$ composer require kennisnet/phpECKS +``` + +## Usage + +``` php +$skeleton = new kennisnet\phpECKS(); +echo $skeleton->echoPhrase('Hello, phpECKS!'); +``` + +## Change log + +Please see [CHANGELOG](CHANGELOG.md) for more information on what has changed recently. + +## Testing + +``` bash +$ composer test +``` + +## Contributing + +Please see [CONTRIBUTING](CONTRIBUTING.md) and [CODE_OF_CONDUCT](CODE_OF_CONDUCT.md) for details. + +## Security + +If you discover any security related issues, please email mail@andreaswarnaar.nl instead of using the issue tracker. + +## Credits + +- [Kennisnet][link-author] +- [All Contributors][link-contributors] + +## License + +The MIT License (MIT). Please see [License File](LICENSE.md) for more information. + +[ico-version]: https://img.shields.io/packagist/v/kennisnet/kennisnet/phpECKS.svg?style=flat-square +[ico-license]: https://img.shields.io/badge/license-MIT-brightgreen.svg?style=flat-square +[ico-travis]: https://img.shields.io/travis/kennisnet/kennisnet/phpECKS/master.svg?style=flat-square +[ico-scrutinizer]: https://img.shields.io/scrutinizer/coverage/g/kennisnet/kennisnet/phpECKS.svg?style=flat-square +[ico-code-quality]: https://img.shields.io/scrutinizer/g/kennisnet/kennisnet/phpECKS.svg?style=flat-square +[ico-downloads]: https://img.shields.io/packagist/dt/kennisnet/kennisnet/phpECKS.svg?style=flat-square + +[link-packagist]: https://packagist.org/packages/kennisnet/kennisnet/phpECKS +[link-travis]: https://travis-ci.org/kennisnet/kennisnet/phpECKS +[link-scrutinizer]: https://scrutinizer-ci.com/g/kennisnet/kennisnet/phpECKS/code-structure +[link-code-quality]: https://scrutinizer-ci.com/g/kennisnet/kennisnet/phpECKS +[link-downloads]: https://packagist.org/packages/kennisnet/kennisnet/phpECKS +[link-author]: https://github.com/kennisnet +[link-contributors]: CONTRIBUTERS.md diff --git a/composer.json b/composer.json new file mode 100644 index 0000000..0a73966 --- /dev/null +++ b/composer.json @@ -0,0 +1,51 @@ +{ + "name": "kennisnet/phpECKS", + "type": "library", + "description": "Normalizer and serializer for the ECK document format", + "keywords": [ + "kennisnet", + "kennisnet/phpECKS", + "ECK", + "Catalogus" + ], + "homepage": "https://github.com/kennisnet/phpECKS", + "license": "MIT", + "authors": [ + { + "name": "Kennisnet", + "email": "mail@andreaswarnaar.nl", + "homepage": "https://github.com/kennisnet", + "role": "Developer" + } + ], + "require": { + "php" : "~7.1" + }, + "require-dev": { + "phpunit/phpunit" : ">=7.0", + "squizlabs/php_codesniffer": "^3.0" + }, + "autoload": { + "psr-4": { + "kennisnet\\phpECKS\\": "src" + } + }, + "autoload-dev": { + "psr-4": { + "kennisnet\\phpECKS\\": "tests" + } + }, + "scripts": { + "test": "phpunit", + "check-style": "phpcs src tests", + "fix-style": "phpcbf src tests" + }, + "extra": { + "branch-alias": { + "dev-master": "1.0-dev" + } + }, + "config": { + "sort-packages": true + } +} diff --git a/phpcs.xml.dist b/phpcs.xml.dist new file mode 100644 index 0000000..ab022e2 --- /dev/null +++ b/phpcs.xml.dist @@ -0,0 +1,14 @@ + + + The coding standard of kennisnet/phpECKS package + + + + + + + + + + + \ No newline at end of file diff --git a/phpunit.xml.dist b/phpunit.xml.dist new file mode 100644 index 0000000..5aeec76 --- /dev/null +++ b/phpunit.xml.dist @@ -0,0 +1,28 @@ + + + + + tests + + + + + src/ + + + + + + + + + diff --git a/src/SkeletonClass.php b/src/SkeletonClass.php new file mode 100644 index 0000000..c39cebb --- /dev/null +++ b/src/SkeletonClass.php @@ -0,0 +1,28 @@ +assertTrue(true); + } +} From acc8f728b6797ec5758fee4ca1c379b892092646 Mon Sep 17 00:00:00 2001 From: Andreas Warnaar Date: Fri, 15 Feb 2019 11:11:19 +0100 Subject: [PATCH 2/2] Setup travis --- .travis.yml | 15 +++++++++++++++ 1 file changed, 15 insertions(+) create mode 100644 .travis.yml diff --git a/.travis.yml b/.travis.yml new file mode 100644 index 0000000..4fe486f --- /dev/null +++ b/.travis.yml @@ -0,0 +1,15 @@ +language: php +php: +  - 7.0 +  - 7.1 +  - 7.2 +  - 7.3 + +before_script: +  - composer self-update +  - composer install --prefer-source --no-interaction --dev + +script: phpunit +notifications: +   on_success: never +   on_failure: always