diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 0d9d208f..b0892c54 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -1,31 +1,33 @@ # Contributing -When contributing to this repository, please first discuss the change you wish to make via issue, -email, or any other method with the owners of this repository before making a change. +When contributing to this repository, please first discuss the change you wish +to make via issue, email, or any other method with the owners of this repository +before making a change. -Please note we have a code of conduct, please follow it in all your interactions with the project. +Please note we have a code of conduct, please follow it in all your interactions +with the project. -## Found an issue? Want a Feature? - -You've found a bug in the source code, a mistake in the documentation or maybe you'd like a new feature? You can help us by submitting an issue to our [GitHub Repository]. Before you create an issue, make sure you search the archive, maybe your question was already answered. +## Issues and feature requests +You've found a bug in the source code, a mistake in the documentation or maybe +you'd like a new feature? You can help us by submitting an issue to our +[GitHub Repository][github]. Before you create an issue, make sure you search +the archive, maybe your question was already answered. Even better: You could submit a pull request with a fix / new feature! -[GitHub Repository]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues - -## Pull Request Process +## Pull request process -1. Search our repository for open or closed [Pull Requests] that relates to your submission. -You don't want to duplicate effort. -4. You may merge the Pull Request in once you have the sign-off of two other developers, or if you - do not have permission to do that, you may request the second reviewer to merge it for you. +1. Search our repository for open or closed [pull requests][prs] that relates + to your submission. You don't want to duplicate effort. -[Pull Requests]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/pulls +2. You may merge the pull request in once you have the sign-off of two other + developers, or if you do not have permission to do that, you may request + the second reviewer to merge it for you. -## Code of Conduct +## Code of conduct -### Our Pledge +### Our pledge In the interest of fostering an open and welcoming environment, we as contributors and maintainers pledge to making participation in our project and @@ -34,29 +36,26 @@ size, disability, ethnicity, gender identity and expression, level of experience nationality, personal appearance, race, religion, or sexual identity and orientation. -### Our Standards +### 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 +- 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 +- 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 +### Our responsibilities Project maintainers are responsible for clarifying the standards of acceptable behavior and are expected to take appropriate and fair corrective action in @@ -92,8 +91,10 @@ 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] +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/ +[github]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/issues +[prs]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/pulls diff --git a/LICENSE.md b/LICENSE.md index 68a3f9df..ca14b5cf 100644 --- a/LICENSE.md +++ b/LICENSE.md @@ -1,6 +1,6 @@ MIT License -Copyright (c) 2016 Dealerdirect B.V. +Copyright (c) 2016-2017 Dealerdirect B.V. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal diff --git a/README.md b/README.md index 04a7c0ca..85f195ee 100644 --- a/README.md +++ b/README.md @@ -1,23 +1,21 @@ # Dealerdirect: PHP_CodeSniffer Standards Composer Installer Plugin -[![Travis](https://img.shields.io/travis/DealerDirect/phpcodesniffer-composer-installer.svg?style=flat-square)](https://travis-ci.org/DealerDirect/phpcodesniffer-composer-installer) -[![Dependency Status](https://www.versioneye.com/user/projects/580be0d1d65a7716b613a790/badge.svg?style=flat-square)](https://www.versioneye.com/user/projects/580be0d1d65a7716b613a790) -[![Packagist](https://img.shields.io/packagist/dt/dealerdirect/phpcodesniffer-composer-installer.svg?style=flat-square)](https://packagist.org/packages/dealerdirect/phpcodesniffer-composer-installer) -![Maintenance](https://img.shields.io/maintenance/yes/2016.svg?style=flat-square) -![Awesome](https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg?style=flat-square) -[![License](https://img.shields.io/github/license/dealerdirect/phpcodesniffer-composer-installer.svg?style=flat-square)](https://github.com/DealerDirect/phpcodesniffer-composer-installer) +![Project Stage][project-stage-shield] +![Maintenance][maintenance-shield] +![Awesome][awesome-shield] +[![License][license-shield]](LICENSE.md) -*Keep life simple...* +[![Scrutinizer][scrutinizer-shield]][scrutinizer] +[![Dependency Status][versioneye-shield]][versioneye] +[![Latest Version on Packagist][packagist-version-shield]][packagist-version] +[![Packagist][packagist-shield]][packagist] -This composer installer plugin allows for easy installation of [PHP_CodeSniffer] coding standards (rulesets). +This composer installer plugin allows for easy installation of [PHP_CodeSniffer][codesniffer] coding standards (rulesets). No more symbolic linking of directories, checking out repositories on specific locations and/or changing the `phpcs` configuration. -*Note: This plugin is compatible with both version 2.x and 3.x of -[PHP_CodeSniffer]* - -[PHP_CodeSniffer]: https://github.com/squizlabs/PHP_CodeSniffer +_Note: This plugin is compatible with both version 2.x and 3.x of_ [PHP_CodeSniffer][codesniffer] ## Usage @@ -33,7 +31,7 @@ Add the following lines to your `composer.json` file: ## Developing Coding Standards -Coding standard can be developed in the way [PHP_CodeSniffer] documents [this]. +Coding standard can be developed normally, as documented by [PHP_CodeSniffer][codesniffer], in the [Coding Standard Tutorial][tutorial]. Create a composer package of your coding standard by adding a `composer.json` file. @@ -54,46 +52,38 @@ Requirements: * Each standard can have a separate directory no deeper than 3 levels from the repository root. * The package `type` must be `phpcodesniffer-standard`. Without this, the plugin will not trigger. -[this]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial - ## Contributing -This is an active open-source project. We are always open to people who want to use the code or contribute to it. +This is an active open-source project. We are always open to people who want to +use the code or contribute to it. -We've set up a separate document for our [contribution guidelines]. +We've set up a separate document for our [contribution guidelines][contributing-guidelines]. Thank you for being involved! :heart_eyes: -[contribution guidelines]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/blob/master/CONTRIBUTING.md - -## Authors & Contributors +## Authors & contributors -The original idea and setup of this repository is by [Franck Nijhof], employee @ Dealerdirect. +The original idea and setup of this repository is by [Franck Nijhof][frenck], employee @ Dealerdirect. -For a full list off all author and/or contributors, please check [this page]. +For a full list off all author and/or contributors, check [the contributors page][contributors]. -[this page]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/graphs/contributors -[Franck Nijhof]: https://github.com/frenck +## Working @ Dealerdirect -## Would you like to work @ Dealerdirect? +Dealerdirect is always on the looking for energetic and hard working developers +and devops engineers. -Dealerdirect is always on the looking for energetic and hard working developers and devops engineers. +Interested in working at Dealerdirect? +Then please be sure to check out [our vacancies][vacancies]. -Interested in working at Dealerdirect? Then please be sure to check out [our vacancies]. +Did not find a matching vacancy? Just [get in touch][get-in-touch]! -Did not find a matching vacancy? Just [get in touch]! - -[WorkingAtDealerdirect.eu] - -[our vacancies]: http://workingatdealerdirect.eu/?post_type=vacancy&s=&department=99 -[get in touch]: http://workingatdealerdirect.eu/open-sollicitatie/ -[WorkingAtDealerdirect.eu]: http://www.workingatdealerdirect.eu +[workingatdealerdirect.eu][workingatdealerdirecteu] ## License The MIT License (MIT) -Copyright (c) 2016 Dealerdirect B.V. +Copyright (c) 2016-2017 Dealerdirect B.V. Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal @@ -112,3 +102,24 @@ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE. + +[project-stage-shield]: https://img.shields.io/badge/Project%20Stage-Development-yellowgreen.svg +[maintenance-shield]: https://img.shields.io/maintenance/yes/2017.svg +[awesome-shield]: https://img.shields.io/badge/awesome%3F-yes-brightgreen.svg +[license-shield]: https://img.shields.io/github/license/dealerdirect/phpcodesniffer-composer-installer.svg +[scrutinizer-shield]: https://img.shields.io/scrutinizer/g/DealerDirect/phpcodesniffer-composer-installer.svg +[scrutinizer]: https://scrutinizer-ci.com/g/DealerDirect/phpcodesniffer-composer-installer/ +[versioneye-shield]: https://www.versioneye.com/user/projects/580be0d1d65a7716b613a790/badge.svg +[versioneye]: https://www.versioneye.com/user/projects/580be0d1d65a7716b613a790 +[packagist-shield]: https://img.shields.io/packagist/dt/dealerdirect/phpcodesniffer-composer-installer.svg +[packagist]: https://packagist.org/packages/dealerdirect/phpcodesniffer-composer-installer +[packagist-version-shield]: https://img.shields.io/packagist/v/dealerdirect/phpcodesniffer-composer-installer.svg +[packagist-version]: https://packagist.org/packages/dealerdirect/phpcodesniffer-composer-installer +[contribution-guidelines]: CONTRIBUTING.md +[frenck]: https://github.com/frenck +[contributors]: https://github.com/dealerdirect/phpcodesniffer-composer-installer/graphs/contributors +[vacancies]: http://workingatdealerdirect.eu/?post_type=vacancy&s=&department=99 +[get-in-touch]: http://workingatdealerdirect.eu/open-sollicitatie/ +[workingatdealerdirecteu]: http://www.workingatdealerdirect.eu +[tutorial]: https://github.com/squizlabs/PHP_CodeSniffer/wiki/Coding-Standard-Tutorial +[codesniffer]: https://github.com/squizlabs/PHP_CodeSniffer