Merge pull request #1 from pixelfederation/open_source

Open source release

.allowed-licenses

@@ -0,0 +1,3 @@
+- BSD-3-Clause
+- LGPL-3.0-or-later
+- MIT

LICENSE

@@ -0,0 +1,21 @@
+Copyright 2021 Pixel Federation s.r.o.
+
+Redistribution and use in source and binary forms, with or without modification, are permitted provided
+that the following conditions are met:
+
+1. Redistributions of source code must retain the above copyright notice, this list of conditions
+and the following disclaimer.
+
+2. Redistributions in binary form must reproduce the above copyright notice, this list of conditions
+and the following disclaimer in the documentation and/or other materials provided with the distribution.
+
+3. Neither the name of the copyright holder nor the names of its contributors may be used to endorse
+or promote products derived from this software without specific prior written permission.
+
+THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES,
+INCLUDING, BUT NOT LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
+DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL,
+SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
+SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY,
+WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
+OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.

README.md

@@ -1,14 +1,14 @@
 # Coding standards
 
-This package provides PHPCS rule set for coding standards in Pixelfederation. It should be included into
-each project that uses PHPCS.
+This package provides PHPCS rule set for coding standards in Pixel Federation. It should be included into
+each project maintained by Pixel Federation that uses PHP Code Sniffer [PHPCS](https://github.com/squizlabs/PHP_CodeSniffer).
 
 ## Example usage
 
 ### 1) Install composer dependencies
 
 ```bash
-composer require pixelfederation/coding-standards:^1.0 --dev
+composer require pixelfederation/coding-standards:^2.0 --dev
 ```
 
 ### 2) Ruleset creation
@@ -29,8 +29,6 @@ Create a file named `phpcs.ruleset.xml` to the root folder of your project with
     <exclude name="SlevomatCodingStandard.Classes.SuperfluousTraitNaming"/>
     <exclude name="SlevomatCodingStandard.Classes.SuperfluousInterfaceNaming"/>
     <exclude name="SlevomatCodingStandard.Classes.SuperfluousExceptionNaming"/> -->
-    <!-- v mastry ale este nie v relese maju takuto smakocinku, takze potom to pripadne exludnite -->
-    <!-- https://github.com/slevomat/coding-standard/blob/master/SlevomatCodingStandard/Sniffs/Files/FunctionLengthSniff.php -->
     <!-- <exclude name="SlevomatCodingStandard.Files.FunctionLength"/> -->
   </rule>
 

composer.json

@@ -3,26 +3,21 @@
   "homepage": "https://git.pixelfederation.com/shared/server-coding-standards",
   "type": "library",
   "description": "Standardized PHPCS sniffs for backend developers.",
-  "license": "proprietary",
+  "license": "BSD-3-Clause",
   "authors": [
     {
       "name": "Martin Fris",
       "email": "[email protected]"
     }
   ],
-  "repositories": [
-    {
-      "type": "composer",
-      "url": "https://satis.pxfd.tech"
-    }
-  ],
   "require": {
     "php": ">=7.2",
     "phpcompatibility/php-compatibility": "^9.3",
     "slevomat/coding-standard": "^7.0.9",
     "squizlabs/php_codesniffer": "^3.5"
   },
   "require-dev": {
+    "madewithlove/license-checker": "^0.10.0"
   },
   "autoload": {
     "psr-4": {